git.gag.com Git - fw/stlink/blob - src/gdb-server.c

   1 /* -*- tab-width:8 -*- */
   2
   3 /*
   4  Copyright (C)  2011 Peter Zotov <whitequark@whitequark.org>
   5  Use of this source code is governed by a BSD-style
   6  license that can be found in the LICENSE file.
   7 */
   8
   9 #include <stdio.h>
  10 #include <string.h>
  11 #include <stdlib.h>
  12 #include <unistd.h>
  13 #include <sys/types.h>
  14 #include <sys/socket.h>
  15 #include <netinet/in.h>
  16 #include <arpa/inet.h>
  17 #include "gdb-remote.h"
  18 #include "stlink-hw.h"
  19
  20 static const char hex[] = "0123456789abcdef";
  21
  22 // configured for STM32F100RB
  23 static const char* const c_memory_map =
  24   "<?xml version=\"1.0\"?>"
  25   "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
  26   "     \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
  27   "<memory-map>"
  28   "  <memory type=\"rom\" start=\"0x00000000\" length=\"0x20000\"/>"    // code = sram or flash
  29   "  <memory type=\"ram\" start=\"0x20000000\" length=\"0x2000\"/>"     // sram 8k
  30   "  <memory type=\"flash\" start=\"0x08000000\" length=\"0x20000\">"   // flash 128k
  31   "    <property name=\"blocksize\">0x400</property>"                   // 1k pages
  32   "  </memory>"
  33   "  <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>" // peripheral regs
  34   "  <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>" // cortex regs
  35   "</memory-map>";
  36
  37 int serve(struct stlink* sl, int port);
  38
  39 int main(int argc, char** argv) {
  40         if(argc != 3) {
  41                 fprintf(stderr, "Usage: %s <port> /dev/sgX\n", argv[0]);
  42                 return 1;
  43         }
  44
  45         struct stlink *sl = stlink_quirk_open(argv[2], 0);
  46         if (sl == NULL)
  47                 return 1;
  48
  49         if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
  50                 stlink_enter_swd_mode(sl);
  51
  52         stlink_core_id(sl);
  53         printf("Debugging ARM core %08x.\n", sl->core_id);
  54
  55         int port = atoi(argv[1]);
  56
  57         while(serve(sl, port) == 0);
  58
  59         stlink_close(sl);
  60
  61         return 0;
  62 }
  63
  64 int serve(struct stlink* sl, int port) {
  65         int sock = socket(AF_INET, SOCK_STREAM, 0);
  66         if(sock < 0) {
  67                 perror("socket");
  68                 return 1;
  69         }
  70
  71         unsigned int val = 1;
  72         setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
  73
  74         struct sockaddr_in serv_addr = {0};
  75         serv_addr.sin_family = AF_INET;
  76         serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
  77         serv_addr.sin_port = htons(port);
  78
  79         if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
  80                 perror("bind");
  81                 return 1;
  82         }
  83
  84         if(listen(sock, 5) < 0) {
  85                 perror("listen");
  86                 return 1;
  87         }
  88
  89         stlink_force_debug(sl);
  90         stlink_reset(sl);
  91
  92         printf("Listening at *:%d...\n", port);
  93
  94         int client = accept(sock, NULL, NULL);
  95         if(client < 0) {
  96                 perror("accept");
  97                 return 1;
  98         }
  99
 100         close(sock);
 101
 102         printf("GDB connected.\n");
 103
 104         while(1) {
 105                 char* packet;
 106
 107                 int status = gdb_recv_packet(client, &packet);
 108                 if(status < 0) {
 109                         fprintf(stderr, "cannot recv: %d\n", status);
 110                         return 1;
 111                 }
 112
 113                 #ifdef DEBUG
 114                 printf("recv: %s\n", packet);
 115                 #endif
 116
 117                 char* reply = NULL;
 118
 119                 switch(packet[0]) {
 120                 case 'q': {
 121                         if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
 122                                 reply = strdup("");
 123                                 break;
 124                         }
 125
 126                         char *separator = strstr(packet, ":"), *params = "";
 127                         if(separator == NULL) {
 128                                 separator = packet + strlen(packet);
 129                         } else {
 130                                 params = separator + 1;
 131                         }
 132
 133                         unsigned queryNameLength = (separator - &packet[1]);
 134                         char* queryName = calloc(queryNameLength + 1, 1);
 135                         strncpy(queryName, &packet[1], queryNameLength);
 136
 137                         #ifdef DEBUG
 138                         printf("query: %s;%s\n", queryName, params);
 139                         #endif
 140
 141                         if(!strcmp(queryName, "Supported")) {
 142                                 reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
 143                         } else if(!strcmp(queryName, "Xfer")) {
 144                                 char *type, *op, *annex, *s_addr, *s_length;
 145                                 char *tok = params;
 146
 147                                 type     = strsep(&tok, ":");
 148                                 op       = strsep(&tok, ":");
 149                                 annex    = strsep(&tok, ":");
 150                                 s_addr   = strsep(&tok, ",");
 151                                 s_length = tok;
 152
 153                                 unsigned addr = strtoul(s_addr, NULL, 16),
 154                                        length = strtoul(s_length, NULL, 16);
 155
 156                                 #ifdef DEBUG
 157                                 printf("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
 158                                         type, op, annex, addr, length);
 159                                 #endif
 160
 161                                 const char* data = NULL;
 162
 163                                 if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
 164                                         data = c_memory_map;
 165
 166                                 if(data) {
 167                                         unsigned data_length = strlen(data);
 168                                         if(addr + length > data_length)
 169                                                 length = data_length - addr;
 170
 171                                         if(length == 0) {
 172                                                 reply = strdup("l");
 173                                         } else {
 174                                                 reply = calloc(length + 2, 1);
 175                                                 reply[0] = 'm';
 176                                                 strncpy(&reply[1], data, length);
 177                                         }
 178                                 }
 179                         }
 180
 181                         if(reply == NULL)
 182                                 reply = strdup("");
 183
 184                         free(queryName);
 185
 186                         break;
 187                 }
 188
 189                 case 'v': {
 190                         char *separator = strstr(packet, ":"), *params = "";
 191                         if(separator == NULL) {
 192                                 separator = packet + strlen(packet);
 193                         } else {
 194                                 params = separator + 1;
 195                         }
 196
 197                         unsigned cmdNameLength = (separator - &packet[1]);
 198                         char* cmdName = calloc(cmdNameLength + 1, 1);
 199                         strncpy(cmdName, &packet[1], cmdNameLength);
 200
 201                         if(!strcmp(cmdName, "FlashErase")) {
 202                                 char *s_addr, *s_length;
 203                                 char *tok = params;
 204
 205                                 s_addr   = strsep(&tok, ",");
 206                                 s_length = tok;
 207
 208                                 unsigned addr = strtoul(s_addr, NULL, 16),
 209                                        length = strtoul(s_length, NULL, 16);
 210
 211                                 #ifdef DEBUG
 212                                 printf("FlashErase: addr:%08x,len:%04x\n",
 213                                         addr, length);
 214                                 #endif
 215
 216                                 for(stm32_addr_t cur = addr;
 217                                                 cur < addr + length; cur += 0x400) {
 218                                         #ifdef DEBUG
 219                                         printf("do_erase: %08x\n", cur);
 220                                         #endif
 221
 222                                         stlink_erase_flash_page(sl, cur);
 223                                 }
 224
 225                                 reply = strdup("OK");
 226                         } else if(!strcmp(cmdName, "FlashWrite")) {
 227                                 char *s_addr, *data;
 228                                 char *tok = params;
 229
 230                                 s_addr = strsep(&tok, ":");
 231                                 data   = tok;
 232
 233                                 unsigned addr = strtoul(s_addr, NULL, 16);
 234                                 unsigned data_length = status - (data - packet);
 235
 236                                 // Length of decoded data cannot be more than
 237                                 // encoded, as escapes are removed.
 238                                 // Additional byte is reserved for alignment fix.
 239                                 uint8_t *decoded = calloc(data_length + 1, 1);
 240                                 unsigned dec_index = 0;
 241                                 for(int i = 0; i < data_length; i++) {
 242                                         if(data[i] == 0x7d) {
 243                                                 i++;
 244                                                 decoded[dec_index++] = data[i] ^ 0x20;
 245                                         } else {
 246                                                 decoded[dec_index++] = data[i];
 247                                         }
 248                                 }
 249
 250                                 // Fix alignment
 251                                 if(dec_index % 2 != 0)
 252                                         dec_index++;
 253
 254                                 #ifdef DEBUG
 255                                 printf("binary packet %d -> %d\n", data_length, dec_index);
 256                                 #endif
 257
 258                                 if(!stlink_write_flash(sl, addr, decoded, dec_index) < 0) {
 259                                         fprintf(stderr, "Flash write or verification failed.\n");
 260                                         reply = strdup("E00");
 261                                 } else {
 262                                         reply = strdup("OK");
 263                                 }
 264                         } else if(!strcmp(cmdName, "FlashDone")) {
 265                                 stlink_reset(sl);
 266
 267                                 reply = strdup("OK");
 268                         }
 269
 270                         if(reply == NULL)
 271                                 reply = strdup("");
 272
 273                         free(cmdName);
 274
 275                         break;
 276                 }
 277
 278                 case 'c':
 279                         stlink_run(sl);
 280
 281                         printf("Core running, waiting for interrupt (either in chip or GDB).\n");
 282
 283                         while(1) {
 284                                 int status = gdb_check_for_interrupt(client);
 285                                 if(status < 0) {
 286                                         fprintf(stderr, "cannot check for int: %d\n", status);
 287                                         return 1;
 288                                 }
 289
 290                                 if(status == 1) {
 291                                         stlink_force_debug(sl);
 292                                         break;
 293                                 }
 294
 295                                 stlink_status(sl);
 296                                 if(sl->core_stat == STLINK_CORE_HALTED) {
 297                                         break;
 298                                 }
 299
 300                                 usleep(200000);
 301                         }
 302
 303                         reply = strdup("S05"); // TRAP
 304                         break;
 305
 306                 case 's':
 307                         stlink_step(sl);
 308
 309                         reply = strdup("S05"); // TRAP
 310                         break;
 311
 312                 case '?':
 313                         reply = strdup("S05"); // TRAP
 314                         break;
 315
 316                 case 'g':
 317                         stlink_read_all_regs(sl);
 318
 319                         reply = calloc(8 * 16 + 1, 1);
 320                         for(int i = 0; i < 16; i++)
 321                                 sprintf(&reply[i * 8], "%08x", htonl(sl->reg.r[i]));
 322
 323                         break;
 324
 325                 case 'p': {
 326                         unsigned id = strtoul(&packet[1], NULL, 16), reg = 0xDEADDEAD;
 327
 328                         if(id < 16) {
 329                                 stlink_read_reg(sl, id);
 330                                 reg = htonl(sl->reg.r[id]);
 331                         } else if(id == 0x19) {
 332                                 stlink_read_reg(sl, 16);
 333                                 reg = htonl(sl->reg.xpsr);
 334                         } else {
 335                                 reply = strdup("E00");
 336                         }
 337
 338                         reply = calloc(8 + 1, 1);
 339                         sprintf(reply, "%08x", reg);
 340
 341                         break;
 342                 }
 343
 344                 case 'P': {
 345                         char* s_reg = &packet[1];
 346                         char* s_value = strstr(&packet[1], "=") + 1;
 347
 348                         unsigned reg   = strtoul(s_reg,   NULL, 16);
 349                         unsigned value = strtoul(s_value, NULL, 16);
 350
 351                         if(reg < 16) {
 352                                 stlink_write_reg(sl, ntohl(value), reg);
 353                         } else if(reg == 0x19) {
 354                                 stlink_write_reg(sl, ntohl(value), 16);
 355                         } else {
 356                                 reply = strdup("E00");
 357                         }
 358
 359                         if(!reply) {
 360                                 reply = strdup("OK");
 361                         }
 362
 363                         break;
 364                 }
 365
 366                 case 'G':
 367                         for(int i = 0; i < 16; i++) {
 368                                 char str[9] = {0};
 369                                 strncpy(str, &packet[1 + i * 8], 8);
 370                                 uint32_t reg = strtoul(str, NULL, 16);
 371                                 stlink_write_reg(sl, ntohl(reg), i);
 372                         }
 373
 374                         reply = strdup("OK");
 375                         break;
 376
 377                 case 'm': {
 378                         char* s_start = &packet[1];
 379                         char* s_count = strstr(&packet[1], ",") + 1;
 380
 381                         stm32_addr_t start = strtoul(s_start, NULL, 16);
 382                         unsigned     count = strtoul(s_count, NULL, 16);
 383
 384                         unsigned adj_start = start % 4;
 385
 386                         stlink_read_mem32(sl, start - adj_start, (count % 4 == 0) ?
 387                                                 count : count + 4 - (count % 4));
 388
 389                         reply = calloc(count * 2 + 1, 1);
 390                         for(int i = 0; i < count; i++) {
 391                                 reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
 392                                 reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
 393                         }
 394
 395                         break;
 396                 }
 397
 398                 case 'M': {
 399                         char* s_start = &packet[1];
 400                         char* s_count = strstr(&packet[1], ",") + 1;
 401                         char* hexdata = strstr(packet, ":") + 1;
 402
 403                         stm32_addr_t start = strtoul(s_start, NULL, 16);
 404                         unsigned     count = strtoul(s_count, NULL, 16);
 405
 406                         for(int i = 0; i < count; i ++) {
 407                                 char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
 408                                 uint8_t byte = strtoul(hex, NULL, 16);
 409                                 sl->q_buf[i] = byte;
 410                         }
 411
 412                         if((count % 4) == 0 && (start % 4) == 0) {
 413                                 stlink_write_mem32(sl, start, count);
 414                         } else {
 415                                 stlink_write_mem8(sl, start, count);
 416                         }
 417
 418                         reply = strdup("OK");
 419
 420                         break;
 421                 }
 422
 423                 case 'k': {
 424                         // After this function will be entered afterwards, the
 425                         // chip will be reset anyway. So this is a no-op.
 426
 427                         close(client);
 428                         return 0;
 429                 }
 430
 431                 default:
 432                         reply = strdup("");
 433                 }
 434
 435                 if(reply) {
 436                         #ifdef DEBUG
 437                         printf("send: %s\n", reply);
 438                         #endif
 439
 440                         int result = gdb_send_packet(client, reply);
 441                         if(result != 0) {
 442                                 fprintf(stderr, "cannot send: %d\n", result);
 443                                 return 1;
 444                         }
 445
 446                         free(reply);
 447                 }
 448
 449                 free(packet);
 450         }
 451
 452         return 0;
 453 }