Added code so gdbserver can fully support the STM32F4 variable page sizes
[fw/stlink] / gdbserver / gdb-server.c
index 04fd2bcb45dbd347915683a6a026a213291352c2..b5d66dff563450f4c068b45a4fe4c01f2b9992c6 100644 (file)
@@ -1,5 +1,5 @@
 /* -*- tab-width:8 -*- */
-
+#define DEBUG 0
 /*
  Copyright (C)  2011 Peter Zotov <whitequark@whitequark.org>
  Use of this source code is governed by a BSD-style
 #include <sys/socket.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
+#include <signal.h>
+
+#include <stlink-common.h>
+
 #include "gdb-remote.h"
-#include "stlink-hw.h"
 
 #define FLASH_BASE 0x08000000
+
+//Allways update the FLASH_PAGE before each use, by calling stlink_calculate_pagesize
 #define FLASH_PAGE (sl->flash_pgsz)
-#define FLASH_PAGE_MASK (~((1 << 10) - 1))
-#define FLASH_SIZE (FLASH_PAGE * 128)
+
+volatile int do_exit = 0;
+void ctrl_c(int sig)
+{
+  do_exit = 1;
+}
 
 static const char hex[] = "0123456789abcdef";
 
@@ -29,55 +38,167 @@ static const char* current_memory_map = NULL;
 struct chip_params {
        uint32_t chip_id;
        char* description;
+        uint32_t flash_size_reg;
        uint32_t max_flash_size, flash_pagesize;
        uint32_t sram_size;
        uint32_t bootrom_base, bootrom_size;
 } const devices[] = {
-       { 0x412, "Low-density device",
-         0x8000,   0x400, 0x2800,  0x1ffff000, 0x800  },
-       { 0x410, "Medium-density device",
-         0x20000,  0x400, 0x5000,  0x1ffff000, 0x800  },
-       { 0x414, "High-density device",
-         0x80000,  0x800, 0x10000, 0x1ffff000, 0x800  },
-       { 0x418, "Connectivity line device",
+       { 0x410, "F1 Medium-density device", 0x1ffff7e0,
+         0x20000,  0x400, 0x5000,  0x1ffff000, 0x800  },               // table 2, pm0063
+       { 0x411, "F2 device", 0, /* No flash size register found in the docs*/
+         0x100000,   0x20000, 0x20000, 0x1fff0000, 0x7800  },  // table 1, pm0059
+       { 0x412, "F1 Low-density device", 0x1ffff7e0,
+         0x8000,   0x400, 0x2800,  0x1ffff000, 0x800  },               // table 1, pm0063
+         /*Page size is variable */
+       { 0x413, "F4 device", 0x1FFF7A10,                                               //RM0090 error same as unique ID
+         0x100000,   0x4000, 0x30000,  0x1fff0000, 0x7800  },  // table 1, pm0081
+       { 0x414, "F1 High-density device", 0x1ffff7e0,
+         0x80000,  0x800, 0x10000, 0x1ffff000, 0x800  },               // table 3 pm0063
+          // This ignores the EEPROM! (and uses the page erase size,
+          // not the sector write protection...)
+       { 0x416, "L1 Med-density device", 0x1FF8004C,                   // table 1, pm0062
+          0x20000, 0x100, 0x4000, 0x1ff00000, 0x1000 },
+       { 0x418, "F1 Connectivity line device", 0x1ffff7e0,
          0x40000,  0x800, 0x10000, 0x1fffb000, 0x4800 },
-       { 0x420, "Medium-density value line device",
+       { 0x420, "F1 Medium-density value line device", 0x1ffff7e0,
          0x20000,  0x400, 0x2000,  0x1ffff000, 0x800  },
-       { 0x428, "High-density value line device",
+       { 0x428, "F1 High-density value line device", 0x1ffff7e0,
          0x80000,  0x800, 0x8000,  0x1ffff000, 0x800  },
-       { 0x430, "XL-density device",
+       { 0x430, "F1 XL-density device", 0x1ffff7e0,                    // pm0068
          0x100000, 0x800, 0x18000, 0x1fffe000, 0x1800 },
        { 0 }
 };
 
-int serve(struct stlink* sl, int port);
-char* make_memory_map(const struct chip_params *params, uint32_t flash_size);
+int serve(stlink_t *sl, int port);
+char* make_memory_map(stlink_t *sl, const struct chip_params *params, uint32_t flash_size);
 
 int main(int argc, char** argv) {
-       if(argc != 3) {
-               fprintf(stderr, "Usage: %s <port> /dev/sgX\n", argv[0]);
-               return 1;
-       }
 
-       struct stlink *sl = stlink_quirk_open(argv[2], 0);
-       if (sl == NULL)
-               return 1;
+       stlink_t *sl = NULL;
+       int port = 0;
+       uint32_t flash_size;
 
-       if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
-               stlink_enter_swd_mode(sl);
+       const char * HelpStr =  "\nUsage:\n"
+                                 "\tst-util [Arguments]\n"
+                                 "\tArguments (no more than 2):\n"
+                                  "\t\t<Port>: Port. Default: 4242.\n"
+                                  "\t\t{usb|sgauto|/dev/sgX}: Transport, "
+                                   "where X = {0, 1, 2, ...}. Default: USB.\n"
+                                 "\tExamples:\n"
+                                  "\t\tst-util 1234\n"
+                                  "\t\tst-util sgauto\n"
+                                  "\t\tst-util 1234 usb\n"
+                                  "\t\tst-util /dev/sgX 1234\n"
+                                  "\t\tst-util 1234 /dev/sgX\n";
+        
+        
+        // Parsing the arguments of command line ...
+        
+        if (argc == 1 || argc > 3) {
+            fprintf(stderr, HelpStr, NULL);
+            return 1;
+        }
+                
+        for(int a = 1; a < argc; a++) {
+            
+            // Port
+            int p = atoi(argv[a]);
+            if (p < 0 || p > 0xFFFF) {
+                fprintf(stderr, "Invalid port\n");
+                fprintf(stderr, HelpStr, NULL);
+                return 1;
+            }
+            if (p > 0 && port == 0) {port = p; continue;}
+            
+            // if (p == 0) ...
+            
+            if (sl != NULL) {
+                fprintf(stderr, "Invalid argumets\n");
+                fprintf(stderr, HelpStr, NULL);
+                return 1;
+            }
+            
+            // usb
+            if (!strcmp(argv[a], "usb")) {
+                sl = stlink_open_usb(10);
+                if(sl == NULL) return 1;
+                continue;
+            }
+
+            // /dev/sgX
+            if (!strncmp(argv[a], "/dev/sgX", 7)) {
+                if(!CONFIG_USE_LIBSG) {
+                    fprintf(stderr, "libsg not use\n");
+                    return 1;
+                }
+                sl = stlink_quirk_open(argv[a], 0);
+                if(sl == NULL) return 1;
+                continue;
+            }
+
+            // sg_auto
+            if (!strcmp(argv[a], "sgauto")) {
+                if(!CONFIG_USE_LIBSG) {
+                    fprintf(stderr, "libsg not use\n");
+                    return 1;
+                }
+
+                // Search ST-LINK (from /dev/sg0 to /dev/sg99)
+                for(int DevNum = 0; DevNum <= 99; DevNum++)
+                {
+                    if(DevNum < 10) {
+                        char DevName[] = "/dev/sgX";
+                        DevName[7] = DevNum + '0';
+                        if ( !access(DevName, F_OK) )
+                            sl = stlink_quirk_open(DevName, 0);
+                    }
+                    else {
+                        char DevName[] = "/dev/sgXY";
+                        DevName[7] = DevNum/10 + '0';
+                        DevName[8] = DevNum%10 + '0';
+                        if ( !access(DevName, F_OK) )
+                            sl = stlink_quirk_open(DevName, 0);
+                    }
+                   if (sl != NULL) break;
+                }
+
+                if(sl == NULL) return 1;
+                continue;
+            }
+            
+            // Invalid argumets
+            fprintf(stderr, "Invalid argumets\n");
+            fprintf(stderr, HelpStr, NULL);
+            return 1;
+        }
+         
+        // Default transport: USB
+        if (sl == NULL) sl = stlink_open_usb(10);
+        // Default port: 4242
+        if (port == 0) port = 4242;
+        
+        // End parsing
+        
+        
+        if (sl == NULL) return 1;
+
+       if (stlink_current_mode(sl) == STLINK_DEV_DFU_MODE) {
+               stlink_exit_dfu_mode(sl);
+       }
 
-       uint32_t chip_id;
+       if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE) {
+         stlink_enter_swd_mode(sl);
+       }
 
-       stlink_read_mem32(sl, 0xE0042000, 4);
-       chip_id = sl->q_buf[0] | (sl->q_buf[1] << 8) | (sl->q_buf[2] << 16) |
-               (sl->q_buf[3] << 24);
+       stlink_identify_device(sl);
+       printf("Chip ID is %08x, Core ID is  %08x.\n", sl->chip_id, sl->core_id);
 
-       printf("Chip ID is %08x.\n", chip_id);
+       sl->verbose=0;
 
        const struct chip_params* params = NULL;
 
        for(int i = 0; i < sizeof(devices) / sizeof(devices[0]); i++) {
-               if(devices[i].chip_id == (chip_id & 0xFFF)) {
+               if(devices[i].chip_id == (sl->chip_id & 0xFFF)) {
                        params = &devices[i];
                        break;
                }
@@ -89,29 +210,62 @@ int main(int argc, char** argv) {
        }
 
        printf("Device connected: %s\n", params->description);
-       printf("Device parameters: SRAM: 0x%x bytes, Flash: up to 0x%x bytes in pages of 0x%x bytes\n",
-               params->sram_size, params->max_flash_size, params->flash_pagesize);
-
-       FLASH_PAGE = params->flash_pagesize;
 
-       uint32_t flash_size;
-
-       stlink_read_mem32(sl, 0x1FFFF7E0, 4);
-       flash_size = sl->q_buf[0] | (sl->q_buf[1] << 8);
+       if(sl->chip_id==STM32F4_CHIP_ID) {
+               flash_size=0x100000;                    //todo: RM0090 error; size register same address as unique ID
+               printf("Device parameters: SRAM: 0x%x bytes, Flash: up to 0x%x bytes with variable page size\n",
+                       params->sram_size, flash_size);
+       }
+       else {
+               printf("Device parameters: SRAM: 0x%x bytes, Flash: up to 0x%x bytes in pages of 0x%x bytes\n",
+                       params->sram_size, params->max_flash_size, params->flash_pagesize);
+               stlink_read_mem32(sl, params->flash_size_reg, 4);
+               flash_size = sl->q_buf[0] | (sl->q_buf[1] << 8);
+               //flash_size_reg is in 1k blocks.
+               flash_size *= 0x400;
+       }
 
-       printf("Flash size is %d KiB.\n", flash_size);
-       // memory map is in 1k blocks.
-       current_memory_map = make_memory_map(params, flash_size * 0x400);
+       /* Init PAGE_SIZE for fixed page size devices.
+        * stlink_calculate_pagesize will then return this value for them.
+        * variable pagesize devices must allways update FLASH_PAGE before use! */
+       FLASH_PAGE = params->flash_pagesize;
+       sl->flash_size=flash_size;
 
-       int port = atoi(argv[1]);
+       printf("Flash size is %d\n", flash_size);
+       current_memory_map = make_memory_map(sl, params, flash_size);
 
        while(serve(sl, port) == 0);
 
+       /* Switch back to mass storage mode before closing. */
+       stlink_run(sl);
+       stlink_exit_debug_mode(sl);
        stlink_close(sl);
 
        return 0;
 }
 
+static const char* const memory_map_template_F4 =
+  "<?xml version=\"1.0\"?>"
+  "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
+  "     \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
+  "<memory-map>"
+  "  <memory type=\"rom\" start=\"0x00000000\" length=\"0x100000\"/>"       // code = sram, bootrom or flash; flash is bigger
+  "  <memory type=\"ram\" start=\"0x20000000\" length=\"0x30000\"/>"        // sram
+  "  <memory type=\"flash\" start=\"0x08000000\" length=\"0x10000\">"          //Sectors 0..3
+  "    <property name=\"blocksize\">0x4000</property>"                                         //16kB
+  "  </memory>"
+  "  <memory type=\"flash\" start=\"0x08010000\" length=\"0x10000\">"          //Sector 4
+  "    <property name=\"blocksize\">0x10000</property>"                                                //64kB
+  "  </memory>"
+  "  <memory type=\"flash\" start=\"0x08020000\" length=\"0x70000\">"          //Sectors 5..11
+  "    <property name=\"blocksize\">0x20000</property>"                                                //128kB
+  "  </memory>"
+  "  <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>"        // peripheral regs
+  "  <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>"        // cortex regs
+  "  <memory type=\"rom\" start=\"0x1fff0000\" length=\"0x7800\"/>"         // bootrom
+  "  <memory type=\"rom\" start=\"0x1fffc000\" length=\"0x10\"/>"              // option byte area
+  "</memory-map>";
+
 static const char* const memory_map_template =
   "<?xml version=\"1.0\"?>"
   "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
@@ -128,17 +282,22 @@ static const char* const memory_map_template =
   "  <memory type=\"rom\" start=\"0x1ffff800\" length=\"0x8\"/>"        // option byte area
   "</memory-map>";
 
-char* make_memory_map(const struct chip_params *params, uint32_t flash_size) {
+char* make_memory_map(stlink_t *sl, const struct chip_params *params, uint32_t flash_size) {
        /* This will be freed in serve() */
        char* map = malloc(4096);
        map[0] = '\0';
 
-       snprintf(map, 4096, memory_map_template,
-                       flash_size,
-                       params->sram_size,
-                       flash_size, params->flash_pagesize,
-                       params->bootrom_base, params->bootrom_size);
-
+       if(sl->chip_id==STM32F4_CHIP_ID) {
+       strcpy(map, memory_map_template_F4);
+    }
+
+    else {
+       snprintf(map, 4096, memory_map_template,
+                       flash_size,
+                       params->sram_size,
+                       flash_size, params->flash_pagesize,
+                       params->bootrom_base, params->bootrom_size);
+    }
        return map;
 }
 
@@ -170,9 +329,7 @@ struct code_hw_watchpoint {
 
 struct code_hw_watchpoint data_watches[DATA_WATCH_NUM];
 
-static void init_data_watchpoints(struct stlink *sl) {
-       int i;
-
+static void init_data_watchpoints(stlink_t *sl) {
        #ifdef DEBUG
        printf("init watchpoints\n");
        #endif
@@ -190,10 +347,10 @@ static void init_data_watchpoints(struct stlink *sl) {
        }
 }
 
-static int add_data_watchpoint(struct stlink* sl, enum watchfun wf, stm32_addr_t addr, unsigned int len)
+static int add_data_watchpoint(stlink_t *sl, enum watchfun wf, stm32_addr_t addr, unsigned int len)
 {
        int i = 0;
-       uint32_t mask, temp;
+       uint32_t mask;
 
        // computer mask
        // find a free watchpoint
@@ -249,7 +406,7 @@ static int add_data_watchpoint(struct stlink* sl, enum watchfun wf, stm32_addr_t
        return -1;
 }
 
-static int delete_data_watchpoint(struct stlink* sl, stm32_addr_t addr)
+static int delete_data_watchpoint(stlink_t *sl, stm32_addr_t addr)
 {
        int i;
 
@@ -285,19 +442,21 @@ struct code_hw_breakpoint {
 
 struct code_hw_breakpoint code_breaks[CODE_BREAK_NUM];
 
-static void init_code_breakpoints(struct stlink* sl) {
+static void init_code_breakpoints(stlink_t *sl) {
        memset(sl->q_buf, 0, 4);
        sl->q_buf[0] = 0x03; // KEY | ENABLE
-       stlink_write_mem32(sl, 0xe0002000, 4);
+       stlink_write_mem32(sl, CM3_REG_FP_CTRL, 4);
+        printf("KARL - should read back as 0x03, not 60 02 00 00\n");
+        stlink_read_mem32(sl, CM3_REG_FP_CTRL, 4);
 
        memset(sl->q_buf, 0, 4);
        for(int i = 0; i < CODE_BREAK_NUM; i++) {
                code_breaks[i].type = 0;
-               stlink_write_mem32(sl, 0xe0002008 + i * 4, 4);
+               stlink_write_mem32(sl, CM3_REG_FP_COMP0 + i * 4, 4);
        }
 }
 
-static int update_code_breakpoint(struct stlink* sl, stm32_addr_t addr, int set) {
+static int update_code_breakpoint(stlink_t *sl, stm32_addr_t addr, int set) {
        stm32_addr_t fpb_addr = addr & ~0x3;
        int type = addr & 0x2 ? CODE_BREAK_HIGH : CODE_BREAK_LOW;
 
@@ -365,13 +524,14 @@ struct flash_block {
 
 static struct flash_block* flash_root;
 
-static int flash_add_block(stm32_addr_t addr, unsigned length, 
-                          struct stlink* sl) {
-       if(addr < FLASH_BASE || addr + length > FLASH_BASE + FLASH_SIZE) {
+static int flash_add_block(stm32_addr_t addr, unsigned length, stlink_t *sl) {
+
+       if(addr < FLASH_BASE || addr + length > FLASH_BASE + sl->flash_size) {
                fprintf(stderr, "flash_add_block: incorrect bounds\n");
                return -1;
        }
 
+       stlink_calculate_pagesize(sl, addr);
        if(addr % FLASH_PAGE != 0 || length % FLASH_PAGE != 0) {
                fprintf(stderr, "flash_add_block: unaligned block\n");
                return -1;
@@ -429,7 +589,7 @@ static int flash_populate(stm32_addr_t addr, uint8_t* data, unsigned length) {
        return 0;
 }
 
-static int flash_go(struct stlink* sl) {
+static int flash_go(stlink_t *sl) {
        int error = -1;
 
        // Some kinds of clock settings do not allow writing to flash.
@@ -442,17 +602,18 @@ static int flash_go(struct stlink* sl) {
 
                unsigned length = fb->length;
                for(stm32_addr_t page = fb->addr; page < fb->addr + fb->length; page += FLASH_PAGE) {
+
+                       //Update FLASH_PAGE
+                       stlink_calculate_pagesize(sl, page);
+
                        #ifdef DEBUG
                        printf("flash_do: page %08x\n", page);
                        #endif
 
-                       stlink_erase_flash_page(sl, page);
-
                        if(stlink_write_flash(sl, page, fb->data + (page - fb->addr),
                                        length > FLASH_PAGE ? FLASH_PAGE : length) < 0)
                                goto error;
-               }
-
+                       }
        }
 
        stlink_reset(sl);
@@ -471,7 +632,7 @@ error:
        return error;
 }
 
-int serve(struct stlink* sl, int port) {
+int serve(stlink_t *sl, int port) {
        int sock = socket(AF_INET, SOCK_STREAM, 0);
        if(sock < 0) {
                perror("socket");
@@ -503,7 +664,9 @@ int serve(struct stlink* sl, int port) {
 
        printf("Listening at *:%d...\n", port);
 
+       (void) signal (SIGINT, ctrl_c);
        int client = accept(sock, NULL, NULL);
+       signal (SIGINT, SIG_DFL);
        if(client < 0) {
                perror("accept");
                return 1;
@@ -533,6 +696,7 @@ int serve(struct stlink* sl, int port) {
                #endif
 
                char* reply = NULL;
+                reg regp;
 
                switch(packet[0]) {
                case 'q': {
@@ -559,8 +723,9 @@ int serve(struct stlink* sl, int port) {
                        if(!strcmp(queryName, "Supported")) {
                                reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
                        } else if(!strcmp(queryName, "Xfer")) {
-                               char *type, *op, *annex, *s_addr, *s_length;
+                               char *type, *op, *s_addr, *s_length;
                                char *tok = params;
+                               char *annex __attribute__((unused));
 
                                type     = strsep(&tok, ":");
                                op       = strsep(&tok, ":");
@@ -727,29 +892,30 @@ int serve(struct stlink* sl, int port) {
                        break;
 
                case 'g':
-                       stlink_read_all_regs(sl);
+                       stlink_read_all_regs(sl, &regp);
 
                        reply = calloc(8 * 16 + 1, 1);
                        for(int i = 0; i < 16; i++)
-                               sprintf(&reply[i * 8], "%08x", htonl(sl->reg.r[i]));
+                               sprintf(&reply[i * 8], "%08x", htonl(regp.r[i]));
 
                        break;
 
                case 'p': {
-                       unsigned id = strtoul(&packet[1], NULL, 16), reg = 0xDEADDEAD;
+                       unsigned id = strtoul(&packet[1], NULL, 16);
+                        unsigned myreg = 0xDEADDEAD;
 
                        if(id < 16) {
-                               stlink_read_reg(sl, id);
-                               reg = htonl(sl->reg.r[id]);
+                               stlink_read_reg(sl, id, &regp);
+                               myreg = htonl(regp.r[id]);
                        } else if(id == 0x19) {
-                               stlink_read_reg(sl, 16);
-                               reg = htonl(sl->reg.xpsr);
+                               stlink_read_reg(sl, 16, &regp);
+                               myreg = htonl(regp.xpsr);
                        } else {
                                reply = strdup("E00");
                        }
 
                        reply = calloc(8 + 1, 1);
-                       sprintf(reply, "%08x", reg);
+                       sprintf(reply, "%08x", myreg);
 
                        break;
                }
@@ -875,7 +1041,7 @@ int serve(struct stlink* sl, int port) {
                case 'z': {
                        char *endptr;
                        stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
-                       stm32_addr_t len  = strtoul(&endptr[1], NULL, 16);
+                       //stm32_addr_t len  = strtoul(&endptr[1], NULL, 16);
 
                        switch (packet[1]) {
                                case '1': // remove breakpoint