Added AHB3 Peripherals definition for STM32F4
[fw/stlink] / gdbserver / gdb-server.c
1 /*
2  * Copyright (C)  2011 Peter Zotov <whitequark@whitequark.org>
3  * Use of this source code is governed by a BSD-style
4  * license that can be found in the LICENSE file.
5  */
6
7 #include <getopt.h>
8 #include <signal.h>
9 #include <stdio.h>
10 #include <string.h>
11 #include <stdlib.h>
12 #include <signal.h>
13 #include <unistd.h>
14 #include <sys/types.h>
15 #ifdef __MINGW32__
16 #include "mingw.h"
17 #else
18 #include <sys/socket.h>
19 #include <netinet/in.h>
20 #include <arpa/inet.h>
21 #endif
22
23 #include <stlink-common.h>
24 #include <uglylogging.h>
25
26 #include "gdb-remote.h"
27 #include "gdb-server.h"
28
29 #define FLASH_BASE 0x08000000
30
31 //Allways update the FLASH_PAGE before each use, by calling stlink_calculate_pagesize
32 #define FLASH_PAGE (sl->flash_pgsz)
33
34 stlink_t *connected_stlink = NULL;
35
36 static const char hex[] = "0123456789abcdef";
37
38 static const char* current_memory_map = NULL;
39
40 typedef struct _st_state_t {
41     // things from command line, bleh
42     int stlink_version;
43     int logging_level;
44     int listen_port;
45     int persistent;
46     int reset;
47 } st_state_t;
48
49
50 int serve(stlink_t *sl, st_state_t *st);
51 char* make_memory_map(stlink_t *sl);
52
53 static void cleanup(int signal __attribute__((unused))) {
54     if (connected_stlink) {
55         /* Switch back to mass storage mode before closing. */
56         stlink_run(connected_stlink);
57         stlink_exit_debug_mode(connected_stlink);
58         stlink_close(connected_stlink);
59     }
60
61     exit(1);
62 }
63
64
65
66 int parse_options(int argc, char** argv, st_state_t *st) {
67     static struct option long_options[] = {
68         {"help", no_argument, NULL, 'h'},
69         {"verbose", optional_argument, NULL, 'v'},
70         {"stlink_version", required_argument, NULL, 's'},
71         {"stlinkv1", no_argument, NULL, '1'},
72         {"listen_port", required_argument, NULL, 'p'},
73         {"multi", optional_argument, NULL, 'm'},
74         {"no-reset", optional_argument, NULL, 'n'},
75         {0, 0, 0, 0},
76     };
77     const char * help_str = "%s - usage:\n\n"
78         "  -h, --help\t\tPrint this help\n"
79         "  -vXX, --verbose=XX\tSpecify a specific verbosity level (0..99)\n"
80         "  -v, --verbose\t\tSpecify generally verbose logging\n"
81         "  -s X, --stlink_version=X\n"
82         "\t\t\tChoose what version of stlink to use, (defaults to 2)\n"
83         "  -1, --stlinkv1\tForce stlink version 1\n"
84         "  -p 4242, --listen_port=1234\n"
85         "\t\t\tSet the gdb server listen port. "
86         "(default port: " STRINGIFY(DEFAULT_GDB_LISTEN_PORT) ")\n"
87         "  -m, --multi\n"
88         "\t\t\tSet gdb server to extended mode.\n"
89         "\t\t\tst-util will continue listening for connections after disconnect.\n"
90         "  -n, --no-reset\n"
91         "\t\t\tDo not reset board on connection.\n"
92         "\n"
93         "The STLINKv2 device to use can be specified in the environment\n"
94         "variable STLINK_DEVICE on the format <USB_BUS>:<USB_ADDR>.\n"
95         "\n"
96         ;
97
98
99     int option_index = 0;
100     int c;
101     int q;
102     while ((c = getopt_long(argc, argv, "hv::s:1p:mn", long_options, &option_index)) != -1) {
103         switch (c) {
104             case 0:
105                 printf("XXXXX Shouldn't really normally come here, only if there's no corresponding option\n");
106                 printf("option %s", long_options[option_index].name);
107                 if (optarg) {
108                     printf(" with arg %s", optarg);
109                 }
110                 printf("\n");
111                 break;
112             case 'h':
113                 printf(help_str, argv[0]);
114                 exit(EXIT_SUCCESS);
115                 break;
116             case 'v':
117                 if (optarg) {
118                     st->logging_level = atoi(optarg);
119                 } else {
120                     st->logging_level = DEFAULT_LOGGING_LEVEL;
121                 }
122                 break;
123             case '1':
124                 st->stlink_version = 1;
125                 break;
126             case 's':
127                 sscanf(optarg, "%i", &q);
128                 if (q < 0 || q > 2) {
129                     fprintf(stderr, "stlink version %d unknown!\n", q);
130                     exit(EXIT_FAILURE);
131                 }
132                 st->stlink_version = q;
133                 break;
134             case 'p':
135                 sscanf(optarg, "%i", &q);
136                 if (q < 0) {
137                     fprintf(stderr, "Can't use a negative port to listen on: %d\n", q);
138                     exit(EXIT_FAILURE);
139                 }
140                 st->listen_port = q;
141                 break;
142             case 'm':
143                 st->persistent = 1;
144                 break;
145             case 'n':
146                 st->reset = 0;
147                 break;
148         }
149     }
150
151     if (optind < argc) {
152         printf("non-option ARGV-elements: ");
153         while (optind < argc)
154             printf("%s ", argv[optind++]);
155         printf("\n");
156     }
157     return 0;
158 }
159
160
161 int main(int argc, char** argv) {
162     int32_t voltage;
163
164     stlink_t *sl = NULL;
165
166     st_state_t state;
167     memset(&state, 0, sizeof(state));
168     // set defaults...
169     state.stlink_version = 2;
170     state.logging_level = DEFAULT_LOGGING_LEVEL;
171     state.listen_port = DEFAULT_GDB_LISTEN_PORT;
172     state.reset = 1;    /* By default, reset board */
173     parse_options(argc, argv, &state);
174     switch (state.stlink_version) {
175         case 2:
176             sl = stlink_open_usb(state.logging_level, 0);
177             if(sl == NULL) return 1;
178             break;
179         case 1:
180             sl = stlink_v1_open(state.logging_level, 0);
181             if(sl == NULL) return 1;
182             break;
183     }
184
185     connected_stlink = sl;
186     signal(SIGINT, &cleanup);
187     signal(SIGTERM, &cleanup);
188
189     if (state.reset) {
190         stlink_reset(sl);
191     }
192
193     ILOG("Chip ID is %08x, Core ID is  %08x.\n", sl->chip_id, sl->core_id);
194
195     voltage = stlink_target_voltage(sl);
196     if (voltage != -1) {
197         ILOG("Target voltage is %d mV.\n", voltage);
198     }
199
200     sl->verbose=0;
201
202     current_memory_map = make_memory_map(sl);
203
204 #ifdef __MINGW32__
205     WSADATA     wsadata;
206     if (WSAStartup(MAKEWORD(2,2),&wsadata) !=0 ) {
207         goto winsock_error;
208     }
209 #endif
210
211     do {
212         serve(sl, &state);
213
214         /* Continue */
215         stlink_run(sl);
216     } while (state.persistent);
217
218 #ifdef __MINGW32__
219 winsock_error:
220     WSACleanup();
221 #endif
222
223     /* Switch back to mass storage mode before closing. */
224     stlink_exit_debug_mode(sl);
225     stlink_close(sl);
226
227     return 0;
228 }
229
230 static const char* const target_description_F4 =
231     "<?xml version=\"1.0\"?>"
232     "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">"
233     "<target version=\"1.0\">"
234     "   <architecture>arm</architecture>"
235     "   <feature name=\"org.gnu.gdb.arm.m-profile\">"
236     "       <reg name=\"r0\" bitsize=\"32\"/>"
237     "       <reg name=\"r1\" bitsize=\"32\"/>"
238     "       <reg name=\"r2\" bitsize=\"32\"/>"
239     "       <reg name=\"r3\" bitsize=\"32\"/>"
240     "       <reg name=\"r4\" bitsize=\"32\"/>"
241     "       <reg name=\"r5\" bitsize=\"32\"/>"
242     "       <reg name=\"r6\" bitsize=\"32\"/>"
243     "       <reg name=\"r7\" bitsize=\"32\"/>"
244     "       <reg name=\"r8\" bitsize=\"32\"/>"
245     "       <reg name=\"r9\" bitsize=\"32\"/>"
246     "       <reg name=\"r10\" bitsize=\"32\"/>"
247     "       <reg name=\"r11\" bitsize=\"32\"/>"
248     "       <reg name=\"r12\" bitsize=\"32\"/>"
249     "       <reg name=\"sp\" bitsize=\"32\" type=\"data_ptr\"/>"
250     "       <reg name=\"lr\" bitsize=\"32\"/>"
251     "       <reg name=\"pc\" bitsize=\"32\" type=\"code_ptr\"/>"
252     "       <reg name=\"xpsr\" bitsize=\"32\" regnum=\"25\"/>"
253     "       <reg name=\"msp\" bitsize=\"32\" regnum=\"26\" type=\"data_ptr\" group=\"general\" />"
254     "       <reg name=\"psp\" bitsize=\"32\" regnum=\"27\" type=\"data_ptr\" group=\"general\" />"
255     "       <reg name=\"control\" bitsize=\"8\" regnum=\"28\" type=\"int\" group=\"general\" />"
256     "       <reg name=\"faultmask\" bitsize=\"8\" regnum=\"29\" type=\"int\" group=\"general\" />"
257     "       <reg name=\"basepri\" bitsize=\"8\" regnum=\"30\" type=\"int\" group=\"general\" />"
258     "       <reg name=\"primask\" bitsize=\"8\" regnum=\"31\" type=\"int\" group=\"general\" />"
259     "       <reg name=\"s0\" bitsize=\"32\" regnum=\"32\" type=\"float\" group=\"float\" />"
260     "       <reg name=\"s1\" bitsize=\"32\" type=\"float\" group=\"float\" />"
261     "       <reg name=\"s2\" bitsize=\"32\" type=\"float\" group=\"float\" />"
262     "       <reg name=\"s3\" bitsize=\"32\" type=\"float\" group=\"float\" />"
263     "       <reg name=\"s4\" bitsize=\"32\" type=\"float\" group=\"float\" />"
264     "       <reg name=\"s5\" bitsize=\"32\" type=\"float\" group=\"float\" />"
265     "       <reg name=\"s6\" bitsize=\"32\" type=\"float\" group=\"float\" />"
266     "       <reg name=\"s7\" bitsize=\"32\" type=\"float\" group=\"float\" />"
267     "       <reg name=\"s8\" bitsize=\"32\" type=\"float\" group=\"float\" />"
268     "       <reg name=\"s9\" bitsize=\"32\" type=\"float\" group=\"float\" />"
269     "       <reg name=\"s10\" bitsize=\"32\" type=\"float\" group=\"float\" />"
270     "       <reg name=\"s11\" bitsize=\"32\" type=\"float\" group=\"float\" />"
271     "       <reg name=\"s12\" bitsize=\"32\" type=\"float\" group=\"float\" />"
272     "       <reg name=\"s13\" bitsize=\"32\" type=\"float\" group=\"float\" />"
273     "       <reg name=\"s14\" bitsize=\"32\" type=\"float\" group=\"float\" />"
274     "       <reg name=\"s15\" bitsize=\"32\" type=\"float\" group=\"float\" />"
275     "       <reg name=\"s16\" bitsize=\"32\" type=\"float\" group=\"float\" />"
276     "       <reg name=\"s17\" bitsize=\"32\" type=\"float\" group=\"float\" />"
277     "       <reg name=\"s18\" bitsize=\"32\" type=\"float\" group=\"float\" />"
278     "       <reg name=\"s19\" bitsize=\"32\" type=\"float\" group=\"float\" />"
279     "       <reg name=\"s20\" bitsize=\"32\" type=\"float\" group=\"float\" />"
280     "       <reg name=\"s21\" bitsize=\"32\" type=\"float\" group=\"float\" />"
281     "       <reg name=\"s22\" bitsize=\"32\" type=\"float\" group=\"float\" />"
282     "       <reg name=\"s23\" bitsize=\"32\" type=\"float\" group=\"float\" />"
283     "       <reg name=\"s24\" bitsize=\"32\" type=\"float\" group=\"float\" />"
284     "       <reg name=\"s25\" bitsize=\"32\" type=\"float\" group=\"float\" />"
285     "       <reg name=\"s26\" bitsize=\"32\" type=\"float\" group=\"float\" />"
286     "       <reg name=\"s27\" bitsize=\"32\" type=\"float\" group=\"float\" />"
287     "       <reg name=\"s28\" bitsize=\"32\" type=\"float\" group=\"float\" />"
288     "       <reg name=\"s29\" bitsize=\"32\" type=\"float\" group=\"float\" />"
289     "       <reg name=\"s30\" bitsize=\"32\" type=\"float\" group=\"float\" />"
290     "       <reg name=\"s31\" bitsize=\"32\" type=\"float\" group=\"float\" />"
291     "       <reg name=\"fpscr\" bitsize=\"32\" type=\"int\" group=\"float\" />"
292     "   </feature>"
293     "</target>";
294
295 static const char* const memory_map_template_F4 =
296     "<?xml version=\"1.0\"?>"
297     "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
298     "     \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
299     "<memory-map>"
300     "  <memory type=\"rom\" start=\"0x00000000\" length=\"0x100000\"/>"     // code = sram, bootrom or flash; flash is bigger
301     "  <memory type=\"ram\" start=\"0x10000000\" length=\"0x10000\"/>"      // ccm ram
302     "  <memory type=\"ram\" start=\"0x20000000\" length=\"0x20000\"/>"      // sram
303     "  <memory type=\"flash\" start=\"0x08000000\" length=\"0x10000\">"     //Sectors 0..3
304     "    <property name=\"blocksize\">0x4000</property>"                    //16kB
305     "  </memory>"
306     "  <memory type=\"flash\" start=\"0x08010000\" length=\"0x10000\">"     //Sector 4
307     "    <property name=\"blocksize\">0x10000</property>"                   //64kB
308     "  </memory>"
309     "  <memory type=\"flash\" start=\"0x08020000\" length=\"0xE0000\">"     //Sectors 5..11
310     "    <property name=\"blocksize\">0x20000</property>"                   //128kB
311     "  </memory>"
312     "  <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>"   // peripheral regs
313     "  <memory type=\"ram\" start=\"0x60000000\" length=\"0x7fffffff\"/>"   // AHB3 Peripherals
314     "  <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>"   // cortex regs
315     "  <memory type=\"rom\" start=\"0x1fff0000\" length=\"0x7800\"/>"       // bootrom
316     "  <memory type=\"rom\" start=\"0x1fffc000\" length=\"0x10\"/>"         // option byte area
317     "</memory-map>";
318
319 static const char* const memory_map_template =
320     "<?xml version=\"1.0\"?>"
321     "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
322     "     \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
323     "<memory-map>"
324     "  <memory type=\"rom\" start=\"0x00000000\" length=\"0x%zx\"/>"        // code = sram, bootrom or flash; flash is bigger
325     "  <memory type=\"ram\" start=\"0x20000000\" length=\"0x%zx\"/>"        // sram 8k
326     "  <memory type=\"flash\" start=\"0x08000000\" length=\"0x%zx\">"
327     "    <property name=\"blocksize\">0x%zx</property>"
328     "  </memory>"
329     "  <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>"   // peripheral regs
330     "  <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>"   // cortex regs
331     "  <memory type=\"rom\" start=\"0x%08x\" length=\"0x%zx\"/>"            // bootrom
332     "  <memory type=\"rom\" start=\"0x1ffff800\" length=\"0x10\"/>"         // option byte area
333     "</memory-map>";
334
335 char* make_memory_map(stlink_t *sl) {
336     /* This will be freed in serve() */
337     char* map = malloc(4096);
338     map[0] = '\0';
339
340     if(sl->chip_id==STM32_CHIPID_F4 || sl->chip_id==STM32_CHIPID_F4_HD) {
341         strcpy(map, memory_map_template_F4);
342     } else {
343         snprintf(map, 4096, memory_map_template,
344                 sl->flash_size,
345                 sl->sram_size,
346                 sl->flash_size, sl->flash_pgsz,
347                 sl->sys_base, sl->sys_size);
348     }
349     return map;
350 }
351
352
353 /*
354  * DWT_COMP0     0xE0001020
355  * DWT_MASK0     0xE0001024
356  * DWT_FUNCTION0 0xE0001028
357  * DWT_COMP1     0xE0001030
358  * DWT_MASK1     0xE0001034
359  * DWT_FUNCTION1 0xE0001038
360  * DWT_COMP2     0xE0001040
361  * DWT_MASK2     0xE0001044
362  * DWT_FUNCTION2 0xE0001048
363  * DWT_COMP3     0xE0001050
364  * DWT_MASK3     0xE0001054
365  * DWT_FUNCTION3 0xE0001058
366  */
367
368 #define DATA_WATCH_NUM 4
369
370 enum watchfun { WATCHDISABLED = 0, WATCHREAD = 5, WATCHWRITE = 6, WATCHACCESS = 7 };
371
372 struct code_hw_watchpoint {
373     stm32_addr_t addr;
374     uint8_t mask;
375     enum watchfun fun;
376 };
377
378 struct code_hw_watchpoint data_watches[DATA_WATCH_NUM];
379
380 static void init_data_watchpoints(stlink_t *sl) {
381     DLOG("init watchpoints\n");
382
383     // set trcena in debug command to turn on dwt unit
384     stlink_write_debug32(sl, 0xE000EDFC,
385             stlink_read_debug32(sl, 0xE000EDFC) | (1<<24));
386
387     // make sure all watchpoints are cleared
388     for(int i = 0; i < DATA_WATCH_NUM; i++) {
389         data_watches[i].fun = WATCHDISABLED;
390         stlink_write_debug32(sl, 0xe0001028 + i * 16, 0);
391     }
392 }
393
394 static int add_data_watchpoint(stlink_t *sl, enum watchfun wf,
395                                stm32_addr_t addr, unsigned int len) {
396     int i = 0;
397     uint32_t mask;
398
399     // computer mask
400     // find a free watchpoint
401     // configure
402
403     mask = -1;
404     i = len;
405     while(i) {
406         i >>= 1;
407         mask++;
408     }
409
410     if((mask != (uint32_t)-1) && (mask < 16)) {
411         for(i = 0; i < DATA_WATCH_NUM; i++) {
412             // is this an empty slot ?
413             if(data_watches[i].fun == WATCHDISABLED) {
414                 DLOG("insert watchpoint %d addr %x wf %u mask %u len %d\n", i, addr, wf, mask, len);
415
416                 data_watches[i].fun = wf;
417                 data_watches[i].addr = addr;
418                 data_watches[i].mask = mask;
419
420                 // insert comparator address
421                 stlink_write_debug32(sl, 0xE0001020 + i * 16, addr);
422
423                 // insert mask
424                 stlink_write_debug32(sl, 0xE0001024 + i * 16, mask);
425
426                 // insert function
427                 stlink_write_debug32(sl, 0xE0001028 + i * 16, wf);
428
429                 // just to make sure the matched bit is clear !
430                 stlink_read_debug32(sl,  0xE0001028 + i * 16);
431                 return 0;
432             }
433         }
434     }
435
436     DLOG("failure: add watchpoints addr %x wf %u len %u\n", addr, wf, len);
437     return -1;
438 }
439
440 static int delete_data_watchpoint(stlink_t *sl, stm32_addr_t addr)
441 {
442     int i;
443
444     for(i = 0 ; i < DATA_WATCH_NUM; i++) {
445         if((data_watches[i].addr == addr) && (data_watches[i].fun != WATCHDISABLED)) {
446             DLOG("delete watchpoint %d addr %x\n", i, addr);
447
448             data_watches[i].fun = WATCHDISABLED;
449             stlink_write_debug32(sl, 0xe0001028 + i * 16, 0);
450
451             return 0;
452         }
453     }
454
455     DLOG("failure: delete watchpoint addr %x\n", addr);
456
457     return -1;
458 }
459
460 #define CODE_BREAK_NUM  6
461 #define CODE_LIT_NUM    2
462 #define CODE_BREAK_LOW  0x01
463 #define CODE_BREAK_HIGH 0x02
464
465 struct code_hw_breakpoint {
466     stm32_addr_t addr;
467     int          type;
468 };
469
470 struct code_hw_breakpoint code_breaks[CODE_BREAK_NUM];
471
472 static void init_code_breakpoints(stlink_t *sl) {
473     memset(sl->q_buf, 0, 4);
474     stlink_write_debug32(sl, CM3_REG_FP_CTRL, 0x03 /*KEY | ENABLE4*/);
475     unsigned int val = stlink_read_debug32(sl, CM3_REG_FP_CTRL);
476     if (((val & 3) != 1) ||
477             ((((val >> 8) & 0x70) | ((val >> 4) & 0xf)) != CODE_BREAK_NUM) ||
478             (((val >> 8) & 0xf) != CODE_LIT_NUM)){
479         ELOG("[FP_CTRL] = 0x%08x expecting 0x%08x\n", val,
480                 ((CODE_BREAK_NUM & 0x70) << 8) | (CODE_LIT_NUM << 8) |  ((CODE_BREAK_NUM & 0xf) << 4) | 1);
481     }
482
483
484     for(int i = 0; i < CODE_BREAK_NUM; i++) {
485         code_breaks[i].type = 0;
486         stlink_write_debug32(sl, CM3_REG_FP_COMP0 + i * 4, 0);
487     }
488 }
489
490 static int update_code_breakpoint(stlink_t *sl, stm32_addr_t addr, int set) {
491     stm32_addr_t fpb_addr = addr & ~0x3;
492     int type = addr & 0x2 ? CODE_BREAK_HIGH : CODE_BREAK_LOW;
493
494     if(addr & 1) {
495         ELOG("update_code_breakpoint: unaligned address %08x\n", addr);
496         return -1;
497     }
498
499     int id = -1;
500     for(int i = 0; i < CODE_BREAK_NUM; i++) {
501         if(fpb_addr == code_breaks[i].addr ||
502                 (set && code_breaks[i].type == 0)) {
503             id = i;
504             break;
505         }
506     }
507
508     if(id == -1) {
509         if(set) return -1; // Free slot not found
510         else    return 0;  // Breakpoint is already removed
511     }
512
513     struct code_hw_breakpoint* brk = &code_breaks[id];
514
515     brk->addr = fpb_addr;
516
517     if(set) brk->type |= type;
518     else        brk->type &= ~type;
519
520     if(brk->type == 0) {
521         DLOG("clearing hw break %d\n", id);
522
523         stlink_write_debug32(sl, 0xe0002008 + id * 4, 0);
524     } else {
525         uint32_t mask = (brk->addr) | 1 | (brk->type << 30);
526
527         DLOG("setting hw break %d at %08x (%d)\n",
528                     id, brk->addr, brk->type);
529         DLOG("reg %08x \n",
530                     mask);
531
532         stlink_write_debug32(sl, 0xe0002008 + id * 4, mask);
533     }
534
535     return 0;
536 }
537
538
539 struct flash_block {
540     stm32_addr_t addr;
541     unsigned     length;
542     uint8_t*     data;
543
544     struct flash_block* next;
545 };
546
547 static struct flash_block* flash_root;
548
549 static int flash_add_block(stm32_addr_t addr, unsigned length, stlink_t *sl) {
550
551     if(addr < FLASH_BASE || addr + length > FLASH_BASE + sl->flash_size) {
552         ELOG("flash_add_block: incorrect bounds\n");
553         return -1;
554     }
555
556     stlink_calculate_pagesize(sl, addr);
557     if(addr % FLASH_PAGE != 0 || length % FLASH_PAGE != 0) {
558         ELOG("flash_add_block: unaligned block\n");
559         return -1;
560     }
561
562     struct flash_block* new = malloc(sizeof(struct flash_block));
563     new->next = flash_root;
564
565     new->addr   = addr;
566     new->length = length;
567     new->data   = calloc(length, 1);
568
569     flash_root = new;
570
571     return 0;
572 }
573
574 static int flash_populate(stm32_addr_t addr, uint8_t* data, unsigned length) {
575     unsigned int fit_blocks = 0, fit_length = 0;
576
577     for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
578         /* Block: ------X------Y--------
579          * Data:            a-----b
580          *                a--b
581          *            a-----------b
582          * Block intersects with data, if:
583          *  a < Y && b > x
584          */
585
586         unsigned X = fb->addr, Y = fb->addr + fb->length;
587         unsigned a = addr, b = addr + length;
588         if(a < Y && b > X) {
589             // from start of the block
590             unsigned start = (a > X ? a : X) - X;
591             unsigned end   = (b > Y ? Y : b) - X;
592
593             memcpy(fb->data + start, data, end - start);
594
595             fit_blocks++;
596             fit_length += end - start;
597         }
598     }
599
600     if(fit_blocks == 0) {
601         ELOG("Unfit data block %08x -> %04x\n", addr, length);
602         return -1;
603     }
604
605     if(fit_length != length) {
606         WLOG("data block %08x -> %04x truncated to %04x\n",
607                 addr, length, fit_length);
608         WLOG("(this is not an error, just a GDB glitch)\n");
609     }
610
611     return 0;
612 }
613
614 static int flash_go(stlink_t *sl) {
615     int error = -1;
616
617     // Some kinds of clock settings do not allow writing to flash.
618     stlink_reset(sl);
619
620     for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
621         DLOG("flash_do: block %08x -> %04x\n", fb->addr, fb->length);
622
623         unsigned length = fb->length;
624         for(stm32_addr_t page = fb->addr; page < fb->addr + fb->length; page += FLASH_PAGE) {
625
626             //Update FLASH_PAGE
627             stlink_calculate_pagesize(sl, page);
628
629             DLOG("flash_do: page %08x\n", page);
630
631             if(stlink_write_flash(sl, page, fb->data + (page - fb->addr),
632                         length > FLASH_PAGE ? FLASH_PAGE : length) < 0)
633                 goto error;
634         }
635     }
636
637     stlink_reset(sl);
638
639     error = 0;
640
641 error:
642     for(struct flash_block* fb = flash_root, *next; fb; fb = next) {
643         next = fb->next;
644         free(fb->data);
645         free(fb);
646     }
647
648     flash_root = NULL;
649
650     return error;
651 }
652
653 int serve(stlink_t *sl, st_state_t *st) {
654     int sock = socket(AF_INET, SOCK_STREAM, 0);
655     if(sock < 0) {
656         perror("socket");
657         return 1;
658     }
659
660     unsigned int val = 1;
661     setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, (char *)&val, sizeof(val));
662
663     struct sockaddr_in serv_addr;
664     memset(&serv_addr,0,sizeof(struct sockaddr_in));
665     serv_addr.sin_family = AF_INET;
666     serv_addr.sin_addr.s_addr = INADDR_ANY;
667     serv_addr.sin_port = htons(st->listen_port);
668
669     if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
670         perror("bind");
671         return 1;
672     }
673
674     if(listen(sock, 5) < 0) {
675         perror("listen");
676         return 1;
677     }
678
679     ILOG("Listening at *:%d...\n", st->listen_port);
680
681     int client = accept(sock, NULL, NULL);
682     //signal (SIGINT, SIG_DFL);
683     if(client < 0) {
684         perror("accept");
685         return 1;
686     }
687
688     close(sock);
689
690     stlink_force_debug(sl);
691     if (st->reset) {
692         stlink_reset(sl);
693     }
694     init_code_breakpoints(sl);
695     init_data_watchpoints(sl);
696
697     ILOG("GDB connected.\n");
698
699     /*
700      * To allow resetting the chip from GDB it is required to
701      * emulate attaching and detaching to target.
702      */
703     unsigned int attached = 1;
704
705     while(1) {
706         char* packet;
707
708         int status = gdb_recv_packet(client, &packet);
709         if(status < 0) {
710             ELOG("cannot recv: %d\n", status);
711             return 1;
712         }
713
714         DLOG("recv: %s\n", packet);
715
716         char* reply = NULL;
717         reg regp;
718
719         switch(packet[0]) {
720             case 'q': {
721                 if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
722                     reply = strdup("");
723                     break;
724                 }
725
726                 char *separator = strstr(packet, ":"), *params = "";
727                 if(separator == NULL) {
728                     separator = packet + strlen(packet);
729                 } else {
730                     params = separator + 1;
731                 }
732
733                 unsigned queryNameLength = (separator - &packet[1]);
734                 char* queryName = calloc(queryNameLength + 1, 1);
735                 strncpy(queryName, &packet[1], queryNameLength);
736
737                 DLOG("query: %s;%s\n", queryName, params);
738
739                 if(!strcmp(queryName, "Supported")) {
740                     if(sl->chip_id==STM32_CHIPID_F4 || sl->chip_id==STM32_CHIPID_F4_HD) {
741                         reply = strdup("PacketSize=3fff;qXfer:memory-map:read+;qXfer:features:read+");
742                     }
743                     else {
744                         reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
745                     }
746                 } else if(!strcmp(queryName, "Xfer")) {
747                     char *type, *op, *__s_addr, *s_length;
748                     char *tok = params;
749                     char *annex __attribute__((unused));
750
751                     type     = strsep(&tok, ":");
752                     op       = strsep(&tok, ":");
753                     annex    = strsep(&tok, ":");
754                     __s_addr   = strsep(&tok, ",");
755                     s_length = tok;
756
757                     unsigned addr = strtoul(__s_addr, NULL, 16),
758                              length = strtoul(s_length, NULL, 16);
759
760                     DLOG("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
761                                 type, op, annex, addr, length);
762
763                     const char* data = NULL;
764
765                     if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
766                         data = current_memory_map;
767
768                     if(!strcmp(type, "features") && !strcmp(op, "read"))
769                         data = target_description_F4;
770
771                     if(data) {
772                         unsigned data_length = strlen(data);
773                         if(addr + length > data_length)
774                             length = data_length - addr;
775
776                         if(length == 0) {
777                             reply = strdup("l");
778                         } else {
779                             reply = calloc(length + 2, 1);
780                             reply[0] = 'm';
781                             strncpy(&reply[1], data, length);
782                         }
783                     }
784                 } else if(!strncmp(queryName, "Rcmd,",4)) {
785                     // Rcmd uses the wrong separator
786                     char *separator = strstr(packet, ","), *params = "";
787                     if(separator == NULL) {
788                         separator = packet + strlen(packet);
789                     } else {
790                         params = separator + 1;
791                     }
792
793
794                     if (!strncmp(params,"726573756d65",12)) {// resume
795                         DLOG("Rcmd: resume\n");
796                         stlink_run(sl);
797
798                         reply = strdup("OK");
799                     } else if (!strncmp(params,"68616c74",8)) { //halt
800                         reply = strdup("OK");
801
802                         stlink_force_debug(sl);
803
804                         DLOG("Rcmd: halt\n");
805                     } else if (!strncmp(params,"6a7461675f7265736574",20)) { //jtag_reset
806                         reply = strdup("OK");
807
808                         stlink_jtag_reset(sl, 0);
809                         stlink_jtag_reset(sl, 1);
810                         stlink_force_debug(sl);
811
812                         DLOG("Rcmd: jtag_reset\n");
813                     } else if (!strncmp(params,"7265736574",10)) { //reset
814                         reply = strdup("OK");
815
816                         stlink_force_debug(sl);
817                         stlink_reset(sl);
818                         init_code_breakpoints(sl);
819                         init_data_watchpoints(sl);
820
821                         DLOG("Rcmd: reset\n");
822                     } else {
823                         DLOG("Rcmd: %s\n", params);
824                     }
825
826                 }
827
828                 if(reply == NULL)
829                     reply = strdup("");
830
831                 free(queryName);
832
833                 break;
834             }
835
836             case 'v': {
837                 char *params = NULL;
838                 char *cmdName = strtok_r(packet, ":;", &params);
839
840                 cmdName++; // vCommand -> Command
841
842                 if(!strcmp(cmdName, "FlashErase")) {
843                     char *__s_addr, *s_length;
844                     char *tok = params;
845
846                     __s_addr   = strsep(&tok, ",");
847                     s_length = tok;
848
849                     unsigned addr = strtoul(__s_addr, NULL, 16),
850                              length = strtoul(s_length, NULL, 16);
851
852                     DLOG("FlashErase: addr:%08x,len:%04x\n",
853                                 addr, length);
854
855                     if(flash_add_block(addr, length, sl) < 0) {
856                         reply = strdup("E00");
857                     } else {
858                         reply = strdup("OK");
859                     }
860                 } else if(!strcmp(cmdName, "FlashWrite")) {
861                     char *__s_addr, *data;
862                     char *tok = params;
863
864                     __s_addr = strsep(&tok, ":");
865                     data   = tok;
866
867                     unsigned addr = strtoul(__s_addr, NULL, 16);
868                     unsigned data_length = status - (data - packet);
869
870                     // Length of decoded data cannot be more than
871                     // encoded, as escapes are removed.
872                     // Additional byte is reserved for alignment fix.
873                     uint8_t *decoded = calloc(data_length + 1, 1);
874                     unsigned dec_index = 0;
875                     for(unsigned int i = 0; i < data_length; i++) {
876                         if(data[i] == 0x7d) {
877                             i++;
878                             decoded[dec_index++] = data[i] ^ 0x20;
879                         } else {
880                             decoded[dec_index++] = data[i];
881                         }
882                     }
883
884                     // Fix alignment
885                     if(dec_index % 2 != 0)
886                         dec_index++;
887
888                     DLOG("binary packet %d -> %d\n", data_length, dec_index);
889
890                     if(flash_populate(addr, decoded, dec_index) < 0) {
891                         reply = strdup("E00");
892                     } else {
893                         reply = strdup("OK");
894                     }
895                 } else if(!strcmp(cmdName, "FlashDone")) {
896                     if(flash_go(sl) < 0) {
897                         reply = strdup("E00");
898                     } else {
899                         reply = strdup("OK");
900                     }
901                 } else if(!strcmp(cmdName, "Kill")) {
902                     attached = 0;
903
904                     reply = strdup("OK");
905                 }
906
907                 if(reply == NULL)
908                     reply = strdup("");
909
910                 break;
911             }
912
913             case 'c':
914                 stlink_run(sl);
915
916                 while(1) {
917                     int status = gdb_check_for_interrupt(client);
918                     if(status < 0) {
919                         ELOG("cannot check for int: %d\n", status);
920                         return 1;
921                     }
922
923                     if(status == 1) {
924                         stlink_force_debug(sl);
925                         break;
926                     }
927
928                     stlink_status(sl);
929                     if(sl->core_stat == STLINK_CORE_HALTED) {
930                         break;
931                     }
932
933                     usleep(100000);
934                 }
935
936                 reply = strdup("S05"); // TRAP
937                 break;
938
939             case 's':
940                 stlink_step(sl);
941
942                 reply = strdup("S05"); // TRAP
943                 break;
944
945             case '?':
946                 if(attached) {
947                     reply = strdup("S05"); // TRAP
948                 } else {
949                     /* Stub shall reply OK if not attached. */
950                     reply = strdup("OK");
951                 }
952                 break;
953
954             case 'g':
955                 stlink_read_all_regs(sl, &regp);
956
957                 reply = calloc(8 * 16 + 1, 1);
958                 for(int i = 0; i < 16; i++)
959                     sprintf(&reply[i * 8], "%08x", htonl(regp.r[i]));
960
961                 break;
962
963             case 'p': {
964                 unsigned id = strtoul(&packet[1], NULL, 16);
965                 unsigned myreg = 0xDEADDEAD;
966
967                 if(id < 16) {
968                     stlink_read_reg(sl, id, &regp);
969                     myreg = htonl(regp.r[id]);
970                 } else if(id == 0x19) {
971                     stlink_read_reg(sl, 16, &regp);
972                     myreg = htonl(regp.xpsr);
973                 } else if(id == 0x1A) {
974                     stlink_read_reg(sl, 17, &regp);
975                     myreg = htonl(regp.main_sp);
976                 } else if(id == 0x1B) {
977                     stlink_read_reg(sl, 18, &regp);
978                     myreg = htonl(regp.process_sp);
979                 } else if(id == 0x1C) {
980                     stlink_read_unsupported_reg(sl, id, &regp);
981                     myreg = htonl(regp.control);
982                 } else if(id == 0x1D) {
983                     stlink_read_unsupported_reg(sl, id, &regp);
984                     myreg = htonl(regp.faultmask);
985                 } else if(id == 0x1E) {
986                     stlink_read_unsupported_reg(sl, id, &regp);
987                     myreg = htonl(regp.basepri);
988                 } else if(id == 0x1F) {
989                     stlink_read_unsupported_reg(sl, id, &regp);
990                     myreg = htonl(regp.primask);
991                 } else if(id >= 0x20 && id < 0x40) {
992                     stlink_read_unsupported_reg(sl, id, &regp);
993                     myreg = htonl(regp.s[id-0x20]);
994                 } else if(id == 0x40) {
995                     stlink_read_unsupported_reg(sl, id, &regp);
996                     myreg = htonl(regp.fpscr);
997                 } else {
998                     reply = strdup("E00");
999                 }
1000
1001                 reply = calloc(8 + 1, 1);
1002                 sprintf(reply, "%08x", myreg);
1003
1004                 break;
1005             }
1006
1007             case 'P': {
1008                 char* s_reg = &packet[1];
1009                 char* s_value = strstr(&packet[1], "=") + 1;
1010
1011                 unsigned reg   = strtoul(s_reg,   NULL, 16);
1012                 unsigned value = strtoul(s_value, NULL, 16);
1013
1014                 if(reg < 16) {
1015                     stlink_write_reg(sl, ntohl(value), reg);
1016                 } else if(reg == 0x19) {
1017                     stlink_write_reg(sl, ntohl(value), 16);
1018                 } else if(reg == 0x1A) {
1019                     stlink_write_reg(sl, ntohl(value), 17);
1020                 } else if(reg == 0x1B) {
1021                     stlink_write_reg(sl, ntohl(value), 18);
1022                 } else if(reg == 0x1C) {
1023                     stlink_write_unsupported_reg(sl, ntohl(value), reg, &regp);
1024                 } else if(reg == 0x1D) {
1025                     stlink_write_unsupported_reg(sl, ntohl(value), reg, &regp);
1026                 } else if(reg == 0x1E) {
1027                     stlink_write_unsupported_reg(sl, ntohl(value), reg, &regp);
1028                 } else if(reg == 0x1F) {
1029                     stlink_write_unsupported_reg(sl, ntohl(value), reg, &regp);
1030                 } else if(reg >= 0x20 && reg < 0x40) {
1031                     stlink_write_unsupported_reg(sl, ntohl(value), reg, &regp);
1032                 } else if(reg == 0x40) {
1033                     stlink_write_unsupported_reg(sl, ntohl(value), reg, &regp);
1034                 } else {
1035                     reply = strdup("E00");
1036                 }
1037
1038                 if(!reply) {
1039                     reply = strdup("OK");
1040                 }
1041
1042                 break;
1043             }
1044
1045             case 'G':
1046                 for(int i = 0; i < 16; i++) {
1047                     char str[9] = {0};
1048                     strncpy(str, &packet[1 + i * 8], 8);
1049                     uint32_t reg = strtoul(str, NULL, 16);
1050                     stlink_write_reg(sl, ntohl(reg), i);
1051                 }
1052
1053                 reply = strdup("OK");
1054                 break;
1055
1056             case 'm': {
1057                 char* s_start = &packet[1];
1058                 char* s_count = strstr(&packet[1], ",") + 1;
1059
1060                 stm32_addr_t start = strtoul(s_start, NULL, 16);
1061                 unsigned     count = strtoul(s_count, NULL, 16);
1062
1063                 unsigned adj_start = start % 4;
1064                 unsigned count_rnd = (count + adj_start + 4 - 1) / 4 * 4;
1065
1066                 stlink_read_mem32(sl, start - adj_start, count_rnd);
1067
1068                 reply = calloc(count * 2 + 1, 1);
1069                 for(unsigned int i = 0; i < count; i++) {
1070                     reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
1071                     reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
1072                 }
1073
1074                 break;
1075             }
1076
1077             case 'M': {
1078                 char* s_start = &packet[1];
1079                 char* s_count = strstr(&packet[1], ",") + 1;
1080                 char* hexdata = strstr(packet, ":") + 1;
1081
1082                 stm32_addr_t start = strtoul(s_start, NULL, 16);
1083                 unsigned     count = strtoul(s_count, NULL, 16);
1084
1085                 if(start % 4) {
1086                     unsigned align_count = 4 - start % 4;
1087                     if (align_count > count) align_count = count;
1088                     for(unsigned int i = 0; i < align_count; i ++) {
1089                         char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
1090                         uint8_t byte = strtoul(hex, NULL, 16);
1091                         sl->q_buf[i] = byte;
1092                     }
1093                     stlink_write_mem8(sl, start, align_count);
1094                     start += align_count;
1095                     count -= align_count;
1096                     hexdata += 2*align_count;
1097                 }
1098
1099                 if(count - count % 4) {
1100                     unsigned aligned_count = count - count % 4;
1101
1102                     for(unsigned int i = 0; i < aligned_count; i ++) {
1103                         char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
1104                         uint8_t byte = strtoul(hex, NULL, 16);
1105                         sl->q_buf[i] = byte;
1106                     }
1107                     stlink_write_mem32(sl, start, aligned_count);
1108                     count -= aligned_count;
1109                     start += aligned_count;
1110                     hexdata += 2*aligned_count;
1111                 }
1112
1113                 if(count) {
1114                     for(unsigned int i = 0; i < count; i ++) {
1115                         char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
1116                         uint8_t byte = strtoul(hex, NULL, 16);
1117                         sl->q_buf[i] = byte;
1118                     }
1119                     stlink_write_mem8(sl, start, count);
1120                 }
1121                 reply = strdup("OK");
1122                 break;
1123             }
1124
1125             case 'Z': {
1126                 char *endptr;
1127                 stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
1128                 stm32_addr_t len  = strtoul(&endptr[1], NULL, 16);
1129
1130                 switch (packet[1]) {
1131                     case '1':
1132                         if(update_code_breakpoint(sl, addr, 1) < 0) {
1133                             reply = strdup("E00");
1134                         } else {
1135                             reply = strdup("OK");
1136                         }
1137                         break;
1138
1139                     case '2':   // insert write watchpoint
1140                     case '3':   // insert read  watchpoint
1141                     case '4': { // insert access watchpoint
1142                         enum watchfun wf;
1143                         if(packet[1] == '2') {
1144                             wf = WATCHWRITE;
1145                         } else if(packet[1] == '3') {
1146                             wf = WATCHREAD;
1147                         } else {
1148                             wf = WATCHACCESS;
1149                         }
1150
1151                         if(add_data_watchpoint(sl, wf, addr, len) < 0) {
1152                             reply = strdup("E00");
1153                         } else {
1154                             reply = strdup("OK");
1155                             break;
1156                         }
1157                     }
1158
1159                     default:
1160                         reply = strdup("");
1161                 }
1162                 break;
1163             }
1164             case 'z': {
1165                 char *endptr;
1166                 stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
1167                 //stm32_addr_t len  = strtoul(&endptr[1], NULL, 16);
1168
1169                 switch (packet[1]) {
1170                     case '1': // remove breakpoint
1171                         update_code_breakpoint(sl, addr, 0);
1172                         reply = strdup("OK");
1173                         break;
1174
1175                     case '2' : // remove write watchpoint
1176                     case '3' : // remove read watchpoint
1177                     case '4' : // remove access watchpoint
1178                         if(delete_data_watchpoint(sl, addr) < 0) {
1179                             reply = strdup("E00");
1180                         } else {
1181                             reply = strdup("OK");
1182                             break;
1183                         }
1184
1185                     default:
1186                         reply = strdup("");
1187                 }
1188                 break;
1189             }
1190
1191             case '!': {
1192                 /*
1193                  * Enter extended mode which allows restarting.
1194                  * We do support that always.
1195                  */
1196
1197                 /*
1198                  * Also, set to persistent mode
1199                  * to allow GDB disconnect.
1200                  */
1201                 st->persistent = 1;
1202
1203                 reply = strdup("OK");
1204
1205                 break;
1206             }
1207
1208             case 'R': {
1209                 /* Reset the core. */
1210
1211                 stlink_reset(sl);
1212                 init_code_breakpoints(sl);
1213                 init_data_watchpoints(sl);
1214
1215                 attached = 1;
1216
1217                 reply = strdup("OK");
1218
1219                 break;
1220             }
1221
1222             default:
1223                 reply = strdup("");
1224         }
1225
1226         if(reply) {
1227             DLOG("send: %s\n", reply);
1228
1229             int result = gdb_send_packet(client, reply);
1230             if(result != 0) {
1231                 ELOG("cannot send: %d\n", result);
1232                 free(reply);
1233                 free(packet);
1234                 return 1;
1235             }
1236
1237             free(reply);
1238         }
1239
1240         free(packet);
1241     }
1242
1243     return 0;
1244 }