Add option parsing and help
[fw/stlink] / gdbserver / gdb-server.c
index 04fd2bcb45dbd347915683a6a026a213291352c2..30ee01483554b85afd8783fb01b050c279cb5628 100644 (file)
@@ -6,6 +6,7 @@
  license that can be found in the LICENSE file.
 */
 
+#include <getopt.h>
 #include <stdio.h>
 #include <string.h>
 #include <stdlib.h>
 #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 DEFAULT_LOGGING_LEVEL 10
+#define DEFAULT_GDB_LISTEN_PORT 4242
+
+#define STRINGIFY_inner(name) #name
+#define STRINGIFY(name) STRINGIFY_inner(name)
 
 #define FLASH_BASE 0x08000000
 #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";
 
 static const char* current_memory_map = NULL;
 
+/*
+ * 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
+
 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
+       { 0x413, "F4 device", 0x1FFF7A10,
+         0x100000,   0x20000, 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);
+typedef struct _st_state_t {
+    // things from command line, bleh
+    int stlink_version;
+    // "/dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTE531X6-if00-port0" is only 58 chars
+    char devicename[100];
+    int logging_level;
+       int listen_port;
+} st_state_t;
+
+
+int serve(stlink_t *sl, int port);
 char* make_memory_map(const struct chip_params *params, uint32_t flash_size);
 
+
+int parse_options(int argc, char** argv, st_state_t *st) {
+    static struct option long_options[] = {
+        {"help", no_argument, NULL, 'h'},
+        {"verbose", optional_argument, NULL, 'v'},
+        {"device", required_argument, NULL, 'd'},
+        {"stlink_version", required_argument, NULL, 's'},
+        {"stlinkv1", no_argument, NULL, '1'},
+               {"listen_port", required_argument, NULL, 'p'},
+        {0, 0, 0, 0},
+    };
+       const char * help_str = "%s - usage:\n\n"
+       "  -h, --help\t\tPrint this help\n"
+       "  -vXX, --verbose=XX\tspecify a specific verbosity level (0..99)\n"
+       "  -v, --verbose\tspecify generally verbose logging\n"
+       "  -d <device>, --device=/dev/stlink2_1\n"
+       "\t\t\tWhere is your stlink device connected?\n"
+       "  -s X, --stlink_version=X\n"
+       "\t\t\tChoose what version of stlink to use, (defaults to 2)\n"
+       "  -1, --stlinkv1\tForce stlink version 1\n"
+       "  -p 4242, --listen_port=1234\n"
+       "\t\t\tSet the gdb server listen port. "
+       "(default port: " STRINGIFY(DEFAULT_GDB_LISTEN_PORT) ")\n"
+       ;
+
+
+    int option_index = 0;
+    int c;
+    int q;
+    while ((c = getopt_long(argc, argv, "hv::d:s:1p:", long_options, &option_index)) != -1) {
+        switch (c) {
+        case 0:
+            printf("XXXXX Shouldn't really normally come here, only if there's no corresponding option\n");
+            printf("option %s", long_options[option_index].name);
+            if (optarg) {
+                printf(" with arg %s", optarg);
+            }
+            printf("\n");
+            break;
+        case 'h':
+            printf(help_str, argv[0]);
+            exit(EXIT_SUCCESS);
+            break;
+        case 'v':
+            if (optarg) {
+                st->logging_level = atoi(optarg);
+            } else {
+                st->logging_level = DEFAULT_LOGGING_LEVEL;
+            }
+            break;
+        case 'd':
+            if (strlen(optarg) > sizeof (st->devicename)) {
+                fprintf(stderr, "device name too long: %ld\n", strlen(optarg));
+            } else {
+                strcpy(st->devicename, optarg);
+            }
+            break;
+               case '1':
+                       st->stlink_version = 1;
+                       break;
+               case 's':
+                       sscanf(optarg, "%i", &q);
+                       if (q < 0 || q > 2) {
+                               fprintf(stderr, "stlink version %d unknown!\n", q);
+                               exit(EXIT_FAILURE);
+                       }
+                       st->stlink_version = q;
+                       break;
+               case 'p':
+                       sscanf(optarg, "%i", &q);
+                       if (q < 0) {
+                               fprintf(stderr, "Can't use a negative port to listen on: %d\n", q);
+                               exit(EXIT_FAILURE);
+                       }
+                       st->listen_port = q;
+                       break;
+        }
+    }
+
+    if (optind < argc) {
+        printf("non-option ARGV-elements: ");
+        while (optind < argc)
+            printf("%s ", argv[optind++]);
+        printf("\n");
+    }
+    return 0;
+}
+
+
 int main(int argc, char** argv) {
-       if(argc != 3) {
-               fprintf(stderr, "Usage: %s <port> /dev/sgX\n", argv[0]);
-               return 1;
+
+       stlink_t *sl = NULL;
+
+       st_state_t state;
+       memset(&state, 0, sizeof(state));
+       // set defaults...
+       state.stlink_version = 2;
+       state.logging_level = 10;
+       state.listen_port = DEFAULT_GDB_LISTEN_PORT;
+       parse_options(argc, argv, &state);
+       switch (state.stlink_version) {
+       case 2:
+               sl = stlink_open_usb(state.logging_level);
+               if(sl == NULL) return 1;
+               break;
+       case 1:
+#if (CONFIG_USE_LIBSG == 1)
+               if (strlen(state.devicename) == 0) {
+                       const int DevNumMax = 99;
+                       int ExistDevCount = 0;
+
+                       for (int DevNum = 0; DevNum <= DevNumMax; DevNum++) {
+                               if (DevNum < 10) {
+                                       char DevName[] = "/dev/sgX";
+                                       const int X_index = 7;
+                                       DevName[X_index] = DevNum + '0';
+                                       if (!access(DevName, F_OK)) {
+                                               sl = stlink_quirk_open(DevName, 0);
+                                               ExistDevCount++;
+                                       }
+                               } else if (DevNum < 100) {
+                                       char DevName[] = "/dev/sgXY";
+                                       const int X_index = 7;
+                                       const int Y_index = 8;
+                                       DevName[X_index] = DevNum / 10 + '0';
+                                       DevName[Y_index] = DevNum % 10 + '0';
+                                       if (!access(DevName, F_OK)) {
+                                               sl = stlink_quirk_open(DevName, 0);
+                                               ExistDevCount++;
+                                       }
+                               }
+                               if (sl != NULL) break;
+                       }
+
+                       if (sl == NULL) {
+                               fprintf(stdout, "\nNumber of /dev/sgX devices found: %i \n",
+                                       ExistDevCount);
+                               fprintf(stderr, "ST-LINK not found\n");
+                               return 1;
+                       }
+               } else {
+                       sl = stlink_quirk_open(state.devicename, state.logging_level);
+               }
+               break;
+#else
+               fprintf(stderr, "Support for stlink v1 disabled at build time...\n");
+               fprintf(stderr, "Perhaps you're on OSX, and we haven't finished removing the libsg deps?\n");
+               exit(EXIT_FAILURE);
+#endif
        }
 
-       struct stlink *sl = stlink_quirk_open(argv[2], 0);
-       if (sl == NULL)
-               return 1;
+       if (stlink_current_mode(sl) == STLINK_DEV_DFU_MODE) {
+               stlink_exit_dfu_mode(sl);
+       }
 
-       if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
-               stlink_enter_swd_mode(sl);
+       if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE) {
+         stlink_enter_swd_mode(sl);
+       }
 
-       uint32_t chip_id;
+       uint32_t chip_id = stlink_chip_id(sl);
+       uint32_t core_id = stlink_core_id(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);
+       /* Fix chip_id for F4 */
+       if (((chip_id & 0xFFF) == 0x411) && (core_id == CORE_M4_R0)) {
+         printf("Fixing wrong chip_id for STM32F4 Rev A errata\n");
+         chip_id = 0x413;
+       }
 
-       printf("Chip ID is %08x.\n", chip_id);
+       printf("Chip ID is %08x, Core ID is  %08x.\n", chip_id, core_id);
 
        const struct chip_params* params = NULL;
 
@@ -96,17 +289,18 @@ int main(int argc, char** argv) {
 
        uint32_t flash_size;
 
-       stlink_read_mem32(sl, 0x1FFFF7E0, 4);
+       stlink_read_mem32(sl, params->flash_size_reg, 4);
        flash_size = sl->q_buf[0] | (sl->q_buf[1] << 8);
 
        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);
 
-       int port = atoi(argv[1]);
-
-       while(serve(sl, port) == 0);
+       while(serve(sl, state.listen_port) == 0);
 
+       /* Switch back to mass storage mode before closing. */
+       stlink_run(sl);
+       stlink_exit_debug_mode(sl);
        stlink_close(sl);
 
        return 0;
@@ -170,9 +364,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 +382,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 +441,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 +477,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;
 
@@ -366,7 +560,7 @@ struct flash_block {
 static struct flash_block* flash_root;
 
 static int flash_add_block(stm32_addr_t addr, unsigned length, 
-                          struct stlink* sl) {
+                          stlink_t *sl) {
        if(addr < FLASH_BASE || addr + length > FLASH_BASE + FLASH_SIZE) {
                fprintf(stderr, "flash_add_block: incorrect bounds\n");
                return -1;
@@ -429,7 +623,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.
@@ -471,7 +665,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 +697,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 +729,7 @@ int serve(struct stlink* sl, int port) {
                #endif
 
                char* reply = NULL;
+                reg regp;
 
                switch(packet[0]) {
                case 'q': {
@@ -559,8 +756,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 +925,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 +1074,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