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