1 /* -*- tab-width:8 -*- */
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.
13 #include <sys/types.h>
14 #include <sys/socket.h>
15 #include <netinet/in.h>
16 #include <arpa/inet.h>
18 #include <stlink-common.h>
20 #include "gdb-remote.h"
22 #define FLASH_BASE 0x08000000
23 #define FLASH_PAGE (sl->flash_pgsz)
24 #define FLASH_PAGE_MASK (~((1 << 10) - 1))
25 #define FLASH_SIZE (FLASH_PAGE * 128)
27 static const char hex[] = "0123456789abcdef";
29 static const char* current_memory_map = NULL;
34 uint32_t max_flash_size, flash_pagesize;
36 uint32_t bootrom_base, bootrom_size;
38 { 0x412, "Low-density device",
39 0x8000, 0x400, 0x2800, 0x1ffff000, 0x800 },
40 { 0x410, "Medium-density device",
41 0x20000, 0x400, 0x5000, 0x1ffff000, 0x800 },
42 { 0x414, "High-density device",
43 0x80000, 0x800, 0x10000, 0x1ffff000, 0x800 },
44 { 0x418, "Connectivity line device",
45 0x40000, 0x800, 0x10000, 0x1fffb000, 0x4800 },
46 { 0x420, "Medium-density value line device",
47 0x20000, 0x400, 0x2000, 0x1ffff000, 0x800 },
48 { 0x428, "High-density value line device",
49 0x80000, 0x800, 0x8000, 0x1ffff000, 0x800 },
50 { 0x430, "XL-density device",
51 0x100000, 0x800, 0x18000, 0x1fffe000, 0x1800 },
55 int serve(stlink_t *sl, int port);
56 char* make_memory_map(const struct chip_params *params, uint32_t flash_size);
58 int main(int argc, char** argv) {
60 fprintf(stderr, "Usage: %s <port> /dev/sgX\n", argv[0]);
64 // FIXME - hardcoded to usb....
65 stlink_t *sl =stlink_open_usb(argv[2], 10);
69 if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
70 stlink_enter_swd_mode(sl);
74 stlink_read_mem32(sl, 0xE0042000, 4);
75 chip_id = sl->q_buf[0] | (sl->q_buf[1] << 8) | (sl->q_buf[2] << 16) |
78 printf("Chip ID is %08x.\n", chip_id);
80 const struct chip_params* params = NULL;
82 for(int i = 0; i < sizeof(devices) / sizeof(devices[0]); i++) {
83 if(devices[i].chip_id == (chip_id & 0xFFF)) {
90 fprintf(stderr, "Cannot recognize the connected device!\n");
94 printf("Device connected: %s\n", params->description);
95 printf("Device parameters: SRAM: 0x%x bytes, Flash: up to 0x%x bytes in pages of 0x%x bytes\n",
96 params->sram_size, params->max_flash_size, params->flash_pagesize);
98 FLASH_PAGE = params->flash_pagesize;
102 stlink_read_mem32(sl, 0x1FFFF7E0, 4);
103 flash_size = sl->q_buf[0] | (sl->q_buf[1] << 8);
105 printf("Flash size is %d KiB.\n", flash_size);
106 // memory map is in 1k blocks.
107 current_memory_map = make_memory_map(params, flash_size * 0x400);
109 int port = atoi(argv[1]);
111 while(serve(sl, port) == 0);
118 static const char* const memory_map_template =
119 "<?xml version=\"1.0\"?>"
120 "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
121 " \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
123 " <memory type=\"rom\" start=\"0x00000000\" length=\"0x%x\"/>" // code = sram, bootrom or flash; flash is bigger
124 " <memory type=\"ram\" start=\"0x20000000\" length=\"0x%x\"/>" // sram 8k
125 " <memory type=\"flash\" start=\"0x08000000\" length=\"0x%x\">"
126 " <property name=\"blocksize\">0x%x</property>"
128 " <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>" // peripheral regs
129 " <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>" // cortex regs
130 " <memory type=\"rom\" start=\"0x%08x\" length=\"0x%x\"/>" // bootrom
131 " <memory type=\"rom\" start=\"0x1ffff800\" length=\"0x8\"/>" // option byte area
134 char* make_memory_map(const struct chip_params *params, uint32_t flash_size) {
135 /* This will be freed in serve() */
136 char* map = malloc(4096);
139 snprintf(map, 4096, memory_map_template,
142 flash_size, params->flash_pagesize,
143 params->bootrom_base, params->bootrom_size);
150 * DWT_COMP0 0xE0001020
151 * DWT_MASK0 0xE0001024
152 * DWT_FUNCTION0 0xE0001028
153 * DWT_COMP1 0xE0001030
154 * DWT_MASK1 0xE0001034
155 * DWT_FUNCTION1 0xE0001038
156 * DWT_COMP2 0xE0001040
157 * DWT_MASK2 0xE0001044
158 * DWT_FUNCTION2 0xE0001048
159 * DWT_COMP3 0xE0001050
160 * DWT_MASK3 0xE0001054
161 * DWT_FUNCTION3 0xE0001058
164 #define DATA_WATCH_NUM 4
166 enum watchfun { WATCHDISABLED = 0, WATCHREAD = 5, WATCHWRITE = 6, WATCHACCESS = 7 };
168 struct code_hw_watchpoint {
174 struct code_hw_watchpoint data_watches[DATA_WATCH_NUM];
176 static void init_data_watchpoints(stlink_t *sl) {
178 printf("init watchpoints\n");
181 // set trcena in debug command to turn on dwt unit
182 stlink_read_mem32(sl, 0xE000EDFC, 4);
184 stlink_write_mem32(sl, 0xE000EDFC, 4);
186 // make sure all watchpoints are cleared
187 memset(sl->q_buf, 0, 4);
188 for(int i = 0; i < DATA_WATCH_NUM; i++) {
189 data_watches[i].fun = WATCHDISABLED;
190 stlink_write_mem32(sl, 0xe0001028 + i * 16, 4);
194 static int add_data_watchpoint(stlink_t *sl, enum watchfun wf, stm32_addr_t addr, unsigned int len)
200 // find a free watchpoint
210 if((mask != -1) && (mask < 16)) {
211 for(i = 0; i < DATA_WATCH_NUM; i++) {
212 // is this an empty slot ?
213 if(data_watches[i].fun == WATCHDISABLED) {
215 printf("insert watchpoint %d addr %x wf %u mask %u len %d\n", i, addr, wf, mask, len);
218 data_watches[i].fun = wf;
219 data_watches[i].addr = addr;
220 data_watches[i].mask = mask;
222 // insert comparator address
223 sl->q_buf[0] = (addr & 0xff);
224 sl->q_buf[1] = ((addr >> 8) & 0xff);
225 sl->q_buf[2] = ((addr >> 16) & 0xff);
226 sl->q_buf[3] = ((addr >> 24) & 0xff);
228 stlink_write_mem32(sl, 0xE0001020 + i * 16, 4);
231 memset(sl->q_buf, 0, 4);
233 stlink_write_mem32(sl, 0xE0001024 + i * 16, 4);
236 memset(sl->q_buf, 0, 4);
238 stlink_write_mem32(sl, 0xE0001028 + i * 16, 4);
240 // just to make sure the matched bit is clear !
241 stlink_read_mem32(sl, 0xE0001028 + i * 16, 4);
248 printf("failure: add watchpoints addr %x wf %u len %u\n", addr, wf, len);
253 static int delete_data_watchpoint(stlink_t *sl, stm32_addr_t addr)
257 for(i = 0 ; i < DATA_WATCH_NUM; i++) {
258 if((data_watches[i].addr == addr) && (data_watches[i].fun != WATCHDISABLED)) {
260 printf("delete watchpoint %d addr %x\n", i, addr);
263 memset(sl->q_buf, 0, 4);
264 data_watches[i].fun = WATCHDISABLED;
265 stlink_write_mem32(sl, 0xe0001028 + i * 16, 4);
272 printf("failure: delete watchpoint addr %x\n", addr);
278 #define CODE_BREAK_NUM 6
279 #define CODE_BREAK_LOW 0x01
280 #define CODE_BREAK_HIGH 0x02
282 struct code_hw_breakpoint {
287 struct code_hw_breakpoint code_breaks[CODE_BREAK_NUM];
289 static void init_code_breakpoints(stlink_t *sl) {
290 memset(sl->q_buf, 0, 4);
291 sl->q_buf[0] = 0x03; // KEY | ENABLE
292 stlink_write_mem32(sl, 0xe0002000, 4);
294 memset(sl->q_buf, 0, 4);
295 for(int i = 0; i < CODE_BREAK_NUM; i++) {
296 code_breaks[i].type = 0;
297 stlink_write_mem32(sl, 0xe0002008 + i * 4, 4);
301 static int update_code_breakpoint(stlink_t *sl, stm32_addr_t addr, int set) {
302 stm32_addr_t fpb_addr = addr & ~0x3;
303 int type = addr & 0x2 ? CODE_BREAK_HIGH : CODE_BREAK_LOW;
306 fprintf(stderr, "update_code_breakpoint: unaligned address %08x\n", addr);
311 for(int i = 0; i < CODE_BREAK_NUM; i++) {
312 if(fpb_addr == code_breaks[i].addr ||
313 (set && code_breaks[i].type == 0)) {
320 if(set) return -1; // Free slot not found
321 else return 0; // Breakpoint is already removed
324 struct code_hw_breakpoint* brk = &code_breaks[id];
326 brk->addr = fpb_addr;
328 if(set) brk->type |= type;
329 else brk->type &= ~type;
331 memset(sl->q_buf, 0, 4);
335 printf("clearing hw break %d\n", id);
338 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
340 sl->q_buf[0] = ( brk->addr & 0xff) | 1;
341 sl->q_buf[1] = ((brk->addr >> 8) & 0xff);
342 sl->q_buf[2] = ((brk->addr >> 16) & 0xff);
343 sl->q_buf[3] = ((brk->addr >> 24) & 0xff) | (brk->type << 6);
346 printf("setting hw break %d at %08x (%d)\n",
347 id, brk->addr, brk->type);
348 printf("reg %02x %02x %02x %02x\n",
349 sl->q_buf[3], sl->q_buf[2], sl->q_buf[1], sl->q_buf[0]);
352 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
364 struct flash_block* next;
367 static struct flash_block* flash_root;
369 static int flash_add_block(stm32_addr_t addr, unsigned length,
371 if(addr < FLASH_BASE || addr + length > FLASH_BASE + FLASH_SIZE) {
372 fprintf(stderr, "flash_add_block: incorrect bounds\n");
376 if(addr % FLASH_PAGE != 0 || length % FLASH_PAGE != 0) {
377 fprintf(stderr, "flash_add_block: unaligned block\n");
381 struct flash_block* new = malloc(sizeof(struct flash_block));
382 new->next = flash_root;
385 new->length = length;
386 new->data = calloc(length, 1);
393 static int flash_populate(stm32_addr_t addr, uint8_t* data, unsigned length) {
394 int fit_blocks = 0, fit_length = 0;
396 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
397 /* Block: ------X------Y--------
401 * Block intersects with data, if:
405 unsigned X = fb->addr, Y = fb->addr + fb->length;
406 unsigned a = addr, b = addr + length;
408 // from start of the block
409 unsigned start = (a > X ? a : X) - X;
410 unsigned end = (b > Y ? Y : b) - X;
412 memcpy(fb->data + start, data, end - start);
415 fit_length += end - start;
419 if(fit_blocks == 0) {
420 fprintf(stderr, "Unfit data block %08x -> %04x\n", addr, length);
424 if(fit_length != length) {
425 fprintf(stderr, "warning: data block %08x -> %04x truncated to %04x\n",
426 addr, length, fit_length);
427 fprintf(stderr, "(this is not an error, just a GDB glitch)\n");
433 static int flash_go(stlink_t *sl) {
436 // Some kinds of clock settings do not allow writing to flash.
439 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
441 printf("flash_do: block %08x -> %04x\n", fb->addr, fb->length);
444 unsigned length = fb->length;
445 for(stm32_addr_t page = fb->addr; page < fb->addr + fb->length; page += FLASH_PAGE) {
447 printf("flash_do: page %08x\n", page);
450 stlink_erase_flash_page(sl, page);
452 if(stlink_write_flash(sl, page, fb->data + (page - fb->addr),
453 length > FLASH_PAGE ? FLASH_PAGE : length) < 0)
464 for(struct flash_block* fb = flash_root, *next; fb; fb = next) {
475 int serve(stlink_t *sl, int port) {
476 int sock = socket(AF_INET, SOCK_STREAM, 0);
482 unsigned int val = 1;
483 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
485 struct sockaddr_in serv_addr = {0};
486 serv_addr.sin_family = AF_INET;
487 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
488 serv_addr.sin_port = htons(port);
490 if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
495 if(listen(sock, 5) < 0) {
500 stlink_force_debug(sl);
502 init_code_breakpoints(sl);
503 init_data_watchpoints(sl);
505 printf("Listening at *:%d...\n", port);
507 int client = accept(sock, NULL, NULL);
515 printf("GDB connected.\n");
518 * To allow resetting the chip from GDB it is required to
519 * emulate attaching and detaching to target.
521 unsigned int attached = 1;
526 int status = gdb_recv_packet(client, &packet);
528 fprintf(stderr, "cannot recv: %d\n", status);
533 printf("recv: %s\n", packet);
541 if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
546 char *separator = strstr(packet, ":"), *params = "";
547 if(separator == NULL) {
548 separator = packet + strlen(packet);
550 params = separator + 1;
553 unsigned queryNameLength = (separator - &packet[1]);
554 char* queryName = calloc(queryNameLength + 1, 1);
555 strncpy(queryName, &packet[1], queryNameLength);
558 printf("query: %s;%s\n", queryName, params);
561 if(!strcmp(queryName, "Supported")) {
562 reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
563 } else if(!strcmp(queryName, "Xfer")) {
564 char *type, *op, *annex, *s_addr, *s_length;
567 type = strsep(&tok, ":");
568 op = strsep(&tok, ":");
569 annex = strsep(&tok, ":");
570 s_addr = strsep(&tok, ",");
573 unsigned addr = strtoul(s_addr, NULL, 16),
574 length = strtoul(s_length, NULL, 16);
577 printf("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
578 type, op, annex, addr, length);
581 const char* data = NULL;
583 if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
584 data = current_memory_map;
587 unsigned data_length = strlen(data);
588 if(addr + length > data_length)
589 length = data_length - addr;
594 reply = calloc(length + 2, 1);
596 strncpy(&reply[1], data, length);
611 char *cmdName = strtok_r(packet, ":;", ¶ms);
613 cmdName++; // vCommand -> Command
615 if(!strcmp(cmdName, "FlashErase")) {
616 char *s_addr, *s_length;
619 s_addr = strsep(&tok, ",");
622 unsigned addr = strtoul(s_addr, NULL, 16),
623 length = strtoul(s_length, NULL, 16);
626 printf("FlashErase: addr:%08x,len:%04x\n",
630 if(flash_add_block(addr, length, sl) < 0) {
631 reply = strdup("E00");
633 reply = strdup("OK");
635 } else if(!strcmp(cmdName, "FlashWrite")) {
639 s_addr = strsep(&tok, ":");
642 unsigned addr = strtoul(s_addr, NULL, 16);
643 unsigned data_length = status - (data - packet);
645 // Length of decoded data cannot be more than
646 // encoded, as escapes are removed.
647 // Additional byte is reserved for alignment fix.
648 uint8_t *decoded = calloc(data_length + 1, 1);
649 unsigned dec_index = 0;
650 for(int i = 0; i < data_length; i++) {
651 if(data[i] == 0x7d) {
653 decoded[dec_index++] = data[i] ^ 0x20;
655 decoded[dec_index++] = data[i];
660 if(dec_index % 2 != 0)
664 printf("binary packet %d -> %d\n", data_length, dec_index);
667 if(flash_populate(addr, decoded, dec_index) < 0) {
668 reply = strdup("E00");
670 reply = strdup("OK");
672 } else if(!strcmp(cmdName, "FlashDone")) {
673 if(flash_go(sl) < 0) {
674 reply = strdup("E00");
676 reply = strdup("OK");
678 } else if(!strcmp(cmdName, "Kill")) {
681 reply = strdup("OK");
694 int status = gdb_check_for_interrupt(client);
696 fprintf(stderr, "cannot check for int: %d\n", status);
701 stlink_force_debug(sl);
706 if(sl->core_stat == STLINK_CORE_HALTED) {
713 reply = strdup("S05"); // TRAP
719 reply = strdup("S05"); // TRAP
724 reply = strdup("S05"); // TRAP
726 /* Stub shall reply OK if not attached. */
727 reply = strdup("OK");
732 stlink_read_all_regs(sl, ®p);
734 reply = calloc(8 * 16 + 1, 1);
735 for(int i = 0; i < 16; i++)
736 sprintf(&reply[i * 8], "%08x", htonl(regp.r[i]));
741 unsigned id = strtoul(&packet[1], NULL, 16);
742 unsigned myreg = 0xDEADDEAD;
745 stlink_read_reg(sl, id, ®p);
746 myreg = htonl(regp.r[id]);
747 } else if(id == 0x19) {
748 stlink_read_reg(sl, 16, ®p);
749 myreg = htonl(regp.xpsr);
751 reply = strdup("E00");
754 reply = calloc(8 + 1, 1);
755 sprintf(reply, "%08x", myreg);
761 char* s_reg = &packet[1];
762 char* s_value = strstr(&packet[1], "=") + 1;
764 unsigned reg = strtoul(s_reg, NULL, 16);
765 unsigned value = strtoul(s_value, NULL, 16);
768 stlink_write_reg(sl, ntohl(value), reg);
769 } else if(reg == 0x19) {
770 stlink_write_reg(sl, ntohl(value), 16);
772 reply = strdup("E00");
776 reply = strdup("OK");
783 for(int i = 0; i < 16; i++) {
785 strncpy(str, &packet[1 + i * 8], 8);
786 uint32_t reg = strtoul(str, NULL, 16);
787 stlink_write_reg(sl, ntohl(reg), i);
790 reply = strdup("OK");
794 char* s_start = &packet[1];
795 char* s_count = strstr(&packet[1], ",") + 1;
797 stm32_addr_t start = strtoul(s_start, NULL, 16);
798 unsigned count = strtoul(s_count, NULL, 16);
800 unsigned adj_start = start % 4;
802 stlink_read_mem32(sl, start - adj_start, (count % 4 == 0) ?
803 count : count + 4 - (count % 4));
805 reply = calloc(count * 2 + 1, 1);
806 for(int i = 0; i < count; i++) {
807 reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
808 reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
815 char* s_start = &packet[1];
816 char* s_count = strstr(&packet[1], ",") + 1;
817 char* hexdata = strstr(packet, ":") + 1;
819 stm32_addr_t start = strtoul(s_start, NULL, 16);
820 unsigned count = strtoul(s_count, NULL, 16);
822 for(int i = 0; i < count; i ++) {
823 char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
824 uint8_t byte = strtoul(hex, NULL, 16);
828 if((count % 4) == 0 && (start % 4) == 0) {
829 stlink_write_mem32(sl, start, count);
831 stlink_write_mem8(sl, start, count);
834 reply = strdup("OK");
841 stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
842 stm32_addr_t len = strtoul(&endptr[1], NULL, 16);
846 if(update_code_breakpoint(sl, addr, 1) < 0) {
847 reply = strdup("E00");
849 reply = strdup("OK");
853 case '2': // insert write watchpoint
854 case '3': // insert read watchpoint
855 case '4': // insert access watchpoint
858 if(packet[1] == '2') {
860 } else if(packet[1] == '3') {
864 if(add_data_watchpoint(sl, wf, addr, len) < 0) {
865 reply = strdup("E00");
867 reply = strdup("OK");
880 stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
881 //stm32_addr_t len = strtoul(&endptr[1], NULL, 16);
884 case '1': // remove breakpoint
885 update_code_breakpoint(sl, addr, 0);
886 reply = strdup("OK");
889 case '2' : // remove write watchpoint
890 case '3' : // remove read watchpoint
891 case '4' : // remove access watchpoint
892 if(delete_data_watchpoint(sl, addr) < 0) {
893 reply = strdup("E00");
895 reply = strdup("OK");
907 * Enter extended mode which allows restarting.
908 * We do support that always.
911 reply = strdup("OK");
917 /* Reset the core. */
920 init_code_breakpoints(sl);
921 init_data_watchpoints(sl);
925 reply = strdup("OK");
936 printf("send: %s\n", reply);
939 int result = gdb_send_packet(client, reply);
941 fprintf(stderr, "cannot send: %d\n", result);