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;
32 * Chip IDs are explained in the appropriate programming manual for the
33 * DBGMCU_IDCODE register (0xE0042000)
38 uint32_t max_flash_size, flash_pagesize;
40 uint32_t bootrom_base, bootrom_size;
42 { 0x410, "F1 Medium-density device",
43 0x20000, 0x400, 0x5000, 0x1ffff000, 0x800 }, // table 2, pm0063
45 0x100000, 0x20000, 0x20000, 0x1ff00000, 0x7800 }, // table 1, pm0059
46 { 0x412, "F1 Low-density device",
47 0x8000, 0x400, 0x2800, 0x1ffff000, 0x800 }, // table 1, pm0063
49 0x100000, 0x20000, 0x20000, 0x1ff00000, 0x7800 }, // table 1, pm0081
50 { 0x414, "F1 High-density device",
51 0x80000, 0x800, 0x10000, 0x1ffff000, 0x800 }, // table 3 pm0063
52 // This ignores the EEPROM! (and uses the page erase size,
53 // not the sector write protection...)
54 { 0x416, "L1 Med-density device", // table 1, pm0062
55 0x20000, 0x100, 0x4000, 0x1ff00000, 0x1000 },
56 { 0x418, "F1 Connectivity line device",
57 0x40000, 0x800, 0x10000, 0x1fffb000, 0x4800 },
58 { 0x420, "F1 Medium-density value line device",
59 0x20000, 0x400, 0x2000, 0x1ffff000, 0x800 },
60 { 0x428, "F1 High-density value line device",
61 0x80000, 0x800, 0x8000, 0x1ffff000, 0x800 },
62 { 0x430, "F1 XL-density device", // pm0068
63 0x100000, 0x800, 0x18000, 0x1fffe000, 0x1800 },
67 int serve(stlink_t *sl, int port);
68 char* make_memory_map(const struct chip_params *params, uint32_t flash_size);
70 int main(int argc, char** argv) {
72 fprintf(stderr, "Usage: %s <port> /dev/sgX\n", argv[0]);
76 // FIXME - hardcoded to usb....
77 stlink_t *sl =stlink_open_usb(argv[2], 10);
81 if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
82 stlink_enter_swd_mode(sl);
84 uint32_t chip_id = stlink_chip_id(sl);
85 printf("Chip ID is %08x.\n", chip_id);
87 const struct chip_params* params = NULL;
89 for(int i = 0; i < sizeof(devices) / sizeof(devices[0]); i++) {
90 if(devices[i].chip_id == (chip_id & 0xFFF)) {
97 fprintf(stderr, "Cannot recognize the connected device!\n");
101 printf("Device connected: %s\n", params->description);
102 printf("Device parameters: SRAM: 0x%x bytes, Flash: up to 0x%x bytes in pages of 0x%x bytes\n",
103 params->sram_size, params->max_flash_size, params->flash_pagesize);
105 FLASH_PAGE = params->flash_pagesize;
109 stlink_read_mem32(sl, 0x1FFFF7E0, 4); // FIXME - that's never going to work!
110 flash_size = sl->q_buf[0] | (sl->q_buf[1] << 8);
112 printf("Flash size is %d KiB.\n", flash_size);
113 // memory map is in 1k blocks.
114 current_memory_map = make_memory_map(params, flash_size * 0x400);
116 int port = atoi(argv[1]);
118 while(serve(sl, port) == 0);
125 static const char* const memory_map_template =
126 "<?xml version=\"1.0\"?>"
127 "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
128 " \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
130 " <memory type=\"rom\" start=\"0x00000000\" length=\"0x%x\"/>" // code = sram, bootrom or flash; flash is bigger
131 " <memory type=\"ram\" start=\"0x20000000\" length=\"0x%x\"/>" // sram 8k
132 " <memory type=\"flash\" start=\"0x08000000\" length=\"0x%x\">"
133 " <property name=\"blocksize\">0x%x</property>"
135 " <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>" // peripheral regs
136 " <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>" // cortex regs
137 " <memory type=\"rom\" start=\"0x%08x\" length=\"0x%x\"/>" // bootrom
138 " <memory type=\"rom\" start=\"0x1ffff800\" length=\"0x8\"/>" // option byte area
141 char* make_memory_map(const struct chip_params *params, uint32_t flash_size) {
142 /* This will be freed in serve() */
143 char* map = malloc(4096);
146 snprintf(map, 4096, memory_map_template,
149 flash_size, params->flash_pagesize,
150 params->bootrom_base, params->bootrom_size);
157 * DWT_COMP0 0xE0001020
158 * DWT_MASK0 0xE0001024
159 * DWT_FUNCTION0 0xE0001028
160 * DWT_COMP1 0xE0001030
161 * DWT_MASK1 0xE0001034
162 * DWT_FUNCTION1 0xE0001038
163 * DWT_COMP2 0xE0001040
164 * DWT_MASK2 0xE0001044
165 * DWT_FUNCTION2 0xE0001048
166 * DWT_COMP3 0xE0001050
167 * DWT_MASK3 0xE0001054
168 * DWT_FUNCTION3 0xE0001058
171 #define DATA_WATCH_NUM 4
173 enum watchfun { WATCHDISABLED = 0, WATCHREAD = 5, WATCHWRITE = 6, WATCHACCESS = 7 };
175 struct code_hw_watchpoint {
181 struct code_hw_watchpoint data_watches[DATA_WATCH_NUM];
183 static void init_data_watchpoints(stlink_t *sl) {
185 printf("init watchpoints\n");
188 // set trcena in debug command to turn on dwt unit
189 stlink_read_mem32(sl, 0xE000EDFC, 4);
191 stlink_write_mem32(sl, 0xE000EDFC, 4);
193 // make sure all watchpoints are cleared
194 memset(sl->q_buf, 0, 4);
195 for(int i = 0; i < DATA_WATCH_NUM; i++) {
196 data_watches[i].fun = WATCHDISABLED;
197 stlink_write_mem32(sl, 0xe0001028 + i * 16, 4);
201 static int add_data_watchpoint(stlink_t *sl, enum watchfun wf, stm32_addr_t addr, unsigned int len)
207 // find a free watchpoint
217 if((mask != -1) && (mask < 16)) {
218 for(i = 0; i < DATA_WATCH_NUM; i++) {
219 // is this an empty slot ?
220 if(data_watches[i].fun == WATCHDISABLED) {
222 printf("insert watchpoint %d addr %x wf %u mask %u len %d\n", i, addr, wf, mask, len);
225 data_watches[i].fun = wf;
226 data_watches[i].addr = addr;
227 data_watches[i].mask = mask;
229 // insert comparator address
230 sl->q_buf[0] = (addr & 0xff);
231 sl->q_buf[1] = ((addr >> 8) & 0xff);
232 sl->q_buf[2] = ((addr >> 16) & 0xff);
233 sl->q_buf[3] = ((addr >> 24) & 0xff);
235 stlink_write_mem32(sl, 0xE0001020 + i * 16, 4);
238 memset(sl->q_buf, 0, 4);
240 stlink_write_mem32(sl, 0xE0001024 + i * 16, 4);
243 memset(sl->q_buf, 0, 4);
245 stlink_write_mem32(sl, 0xE0001028 + i * 16, 4);
247 // just to make sure the matched bit is clear !
248 stlink_read_mem32(sl, 0xE0001028 + i * 16, 4);
255 printf("failure: add watchpoints addr %x wf %u len %u\n", addr, wf, len);
260 static int delete_data_watchpoint(stlink_t *sl, stm32_addr_t addr)
264 for(i = 0 ; i < DATA_WATCH_NUM; i++) {
265 if((data_watches[i].addr == addr) && (data_watches[i].fun != WATCHDISABLED)) {
267 printf("delete watchpoint %d addr %x\n", i, addr);
270 memset(sl->q_buf, 0, 4);
271 data_watches[i].fun = WATCHDISABLED;
272 stlink_write_mem32(sl, 0xe0001028 + i * 16, 4);
279 printf("failure: delete watchpoint addr %x\n", addr);
285 #define CODE_BREAK_NUM 6
286 #define CODE_BREAK_LOW 0x01
287 #define CODE_BREAK_HIGH 0x02
289 struct code_hw_breakpoint {
294 struct code_hw_breakpoint code_breaks[CODE_BREAK_NUM];
296 static void init_code_breakpoints(stlink_t *sl) {
297 memset(sl->q_buf, 0, 4);
298 sl->q_buf[0] = 0x03; // KEY | ENABLE
299 stlink_write_mem32(sl, 0xe0002000, 4);
301 memset(sl->q_buf, 0, 4);
302 for(int i = 0; i < CODE_BREAK_NUM; i++) {
303 code_breaks[i].type = 0;
304 stlink_write_mem32(sl, 0xe0002008 + i * 4, 4);
308 static int update_code_breakpoint(stlink_t *sl, stm32_addr_t addr, int set) {
309 stm32_addr_t fpb_addr = addr & ~0x3;
310 int type = addr & 0x2 ? CODE_BREAK_HIGH : CODE_BREAK_LOW;
313 fprintf(stderr, "update_code_breakpoint: unaligned address %08x\n", addr);
318 for(int i = 0; i < CODE_BREAK_NUM; i++) {
319 if(fpb_addr == code_breaks[i].addr ||
320 (set && code_breaks[i].type == 0)) {
327 if(set) return -1; // Free slot not found
328 else return 0; // Breakpoint is already removed
331 struct code_hw_breakpoint* brk = &code_breaks[id];
333 brk->addr = fpb_addr;
335 if(set) brk->type |= type;
336 else brk->type &= ~type;
338 memset(sl->q_buf, 0, 4);
342 printf("clearing hw break %d\n", id);
345 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
347 sl->q_buf[0] = ( brk->addr & 0xff) | 1;
348 sl->q_buf[1] = ((brk->addr >> 8) & 0xff);
349 sl->q_buf[2] = ((brk->addr >> 16) & 0xff);
350 sl->q_buf[3] = ((brk->addr >> 24) & 0xff) | (brk->type << 6);
353 printf("setting hw break %d at %08x (%d)\n",
354 id, brk->addr, brk->type);
355 printf("reg %02x %02x %02x %02x\n",
356 sl->q_buf[3], sl->q_buf[2], sl->q_buf[1], sl->q_buf[0]);
359 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
371 struct flash_block* next;
374 static struct flash_block* flash_root;
376 static int flash_add_block(stm32_addr_t addr, unsigned length,
378 if(addr < FLASH_BASE || addr + length > FLASH_BASE + FLASH_SIZE) {
379 fprintf(stderr, "flash_add_block: incorrect bounds\n");
383 if(addr % FLASH_PAGE != 0 || length % FLASH_PAGE != 0) {
384 fprintf(stderr, "flash_add_block: unaligned block\n");
388 struct flash_block* new = malloc(sizeof(struct flash_block));
389 new->next = flash_root;
392 new->length = length;
393 new->data = calloc(length, 1);
400 static int flash_populate(stm32_addr_t addr, uint8_t* data, unsigned length) {
401 int fit_blocks = 0, fit_length = 0;
403 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
404 /* Block: ------X------Y--------
408 * Block intersects with data, if:
412 unsigned X = fb->addr, Y = fb->addr + fb->length;
413 unsigned a = addr, b = addr + length;
415 // from start of the block
416 unsigned start = (a > X ? a : X) - X;
417 unsigned end = (b > Y ? Y : b) - X;
419 memcpy(fb->data + start, data, end - start);
422 fit_length += end - start;
426 if(fit_blocks == 0) {
427 fprintf(stderr, "Unfit data block %08x -> %04x\n", addr, length);
431 if(fit_length != length) {
432 fprintf(stderr, "warning: data block %08x -> %04x truncated to %04x\n",
433 addr, length, fit_length);
434 fprintf(stderr, "(this is not an error, just a GDB glitch)\n");
440 static int flash_go(stlink_t *sl) {
443 // Some kinds of clock settings do not allow writing to flash.
446 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
448 printf("flash_do: block %08x -> %04x\n", fb->addr, fb->length);
451 unsigned length = fb->length;
452 for(stm32_addr_t page = fb->addr; page < fb->addr + fb->length; page += FLASH_PAGE) {
454 printf("flash_do: page %08x\n", page);
457 stlink_erase_flash_page(sl, page);
459 if(stlink_write_flash(sl, page, fb->data + (page - fb->addr),
460 length > FLASH_PAGE ? FLASH_PAGE : length) < 0)
471 for(struct flash_block* fb = flash_root, *next; fb; fb = next) {
482 int serve(stlink_t *sl, int port) {
483 int sock = socket(AF_INET, SOCK_STREAM, 0);
489 unsigned int val = 1;
490 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
492 struct sockaddr_in serv_addr = {0};
493 serv_addr.sin_family = AF_INET;
494 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
495 serv_addr.sin_port = htons(port);
497 if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
502 if(listen(sock, 5) < 0) {
507 stlink_force_debug(sl);
509 init_code_breakpoints(sl);
510 init_data_watchpoints(sl);
512 printf("Listening at *:%d...\n", port);
514 int client = accept(sock, NULL, NULL);
522 printf("GDB connected.\n");
525 * To allow resetting the chip from GDB it is required to
526 * emulate attaching and detaching to target.
528 unsigned int attached = 1;
533 int status = gdb_recv_packet(client, &packet);
535 fprintf(stderr, "cannot recv: %d\n", status);
540 printf("recv: %s\n", packet);
548 if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
553 char *separator = strstr(packet, ":"), *params = "";
554 if(separator == NULL) {
555 separator = packet + strlen(packet);
557 params = separator + 1;
560 unsigned queryNameLength = (separator - &packet[1]);
561 char* queryName = calloc(queryNameLength + 1, 1);
562 strncpy(queryName, &packet[1], queryNameLength);
565 printf("query: %s;%s\n", queryName, params);
568 if(!strcmp(queryName, "Supported")) {
569 reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
570 } else if(!strcmp(queryName, "Xfer")) {
571 char *type, *op, *annex, *s_addr, *s_length;
574 type = strsep(&tok, ":");
575 op = strsep(&tok, ":");
576 annex = strsep(&tok, ":");
577 s_addr = strsep(&tok, ",");
580 unsigned addr = strtoul(s_addr, NULL, 16),
581 length = strtoul(s_length, NULL, 16);
584 printf("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
585 type, op, annex, addr, length);
588 const char* data = NULL;
590 if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
591 data = current_memory_map;
594 unsigned data_length = strlen(data);
595 if(addr + length > data_length)
596 length = data_length - addr;
601 reply = calloc(length + 2, 1);
603 strncpy(&reply[1], data, length);
618 char *cmdName = strtok_r(packet, ":;", ¶ms);
620 cmdName++; // vCommand -> Command
622 if(!strcmp(cmdName, "FlashErase")) {
623 char *s_addr, *s_length;
626 s_addr = strsep(&tok, ",");
629 unsigned addr = strtoul(s_addr, NULL, 16),
630 length = strtoul(s_length, NULL, 16);
633 printf("FlashErase: addr:%08x,len:%04x\n",
637 if(flash_add_block(addr, length, sl) < 0) {
638 reply = strdup("E00");
640 reply = strdup("OK");
642 } else if(!strcmp(cmdName, "FlashWrite")) {
646 s_addr = strsep(&tok, ":");
649 unsigned addr = strtoul(s_addr, NULL, 16);
650 unsigned data_length = status - (data - packet);
652 // Length of decoded data cannot be more than
653 // encoded, as escapes are removed.
654 // Additional byte is reserved for alignment fix.
655 uint8_t *decoded = calloc(data_length + 1, 1);
656 unsigned dec_index = 0;
657 for(int i = 0; i < data_length; i++) {
658 if(data[i] == 0x7d) {
660 decoded[dec_index++] = data[i] ^ 0x20;
662 decoded[dec_index++] = data[i];
667 if(dec_index % 2 != 0)
671 printf("binary packet %d -> %d\n", data_length, dec_index);
674 if(flash_populate(addr, decoded, dec_index) < 0) {
675 reply = strdup("E00");
677 reply = strdup("OK");
679 } else if(!strcmp(cmdName, "FlashDone")) {
680 if(flash_go(sl) < 0) {
681 reply = strdup("E00");
683 reply = strdup("OK");
685 } else if(!strcmp(cmdName, "Kill")) {
688 reply = strdup("OK");
701 int status = gdb_check_for_interrupt(client);
703 fprintf(stderr, "cannot check for int: %d\n", status);
708 stlink_force_debug(sl);
713 if(sl->core_stat == STLINK_CORE_HALTED) {
720 reply = strdup("S05"); // TRAP
726 reply = strdup("S05"); // TRAP
731 reply = strdup("S05"); // TRAP
733 /* Stub shall reply OK if not attached. */
734 reply = strdup("OK");
739 stlink_read_all_regs(sl, ®p);
741 reply = calloc(8 * 16 + 1, 1);
742 for(int i = 0; i < 16; i++)
743 sprintf(&reply[i * 8], "%08x", htonl(regp.r[i]));
748 unsigned id = strtoul(&packet[1], NULL, 16);
749 unsigned myreg = 0xDEADDEAD;
752 stlink_read_reg(sl, id, ®p);
753 myreg = htonl(regp.r[id]);
754 } else if(id == 0x19) {
755 stlink_read_reg(sl, 16, ®p);
756 myreg = htonl(regp.xpsr);
758 reply = strdup("E00");
761 reply = calloc(8 + 1, 1);
762 sprintf(reply, "%08x", myreg);
768 char* s_reg = &packet[1];
769 char* s_value = strstr(&packet[1], "=") + 1;
771 unsigned reg = strtoul(s_reg, NULL, 16);
772 unsigned value = strtoul(s_value, NULL, 16);
775 stlink_write_reg(sl, ntohl(value), reg);
776 } else if(reg == 0x19) {
777 stlink_write_reg(sl, ntohl(value), 16);
779 reply = strdup("E00");
783 reply = strdup("OK");
790 for(int i = 0; i < 16; i++) {
792 strncpy(str, &packet[1 + i * 8], 8);
793 uint32_t reg = strtoul(str, NULL, 16);
794 stlink_write_reg(sl, ntohl(reg), i);
797 reply = strdup("OK");
801 char* s_start = &packet[1];
802 char* s_count = strstr(&packet[1], ",") + 1;
804 stm32_addr_t start = strtoul(s_start, NULL, 16);
805 unsigned count = strtoul(s_count, NULL, 16);
807 unsigned adj_start = start % 4;
809 stlink_read_mem32(sl, start - adj_start, (count % 4 == 0) ?
810 count : count + 4 - (count % 4));
812 reply = calloc(count * 2 + 1, 1);
813 for(int i = 0; i < count; i++) {
814 reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
815 reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
822 char* s_start = &packet[1];
823 char* s_count = strstr(&packet[1], ",") + 1;
824 char* hexdata = strstr(packet, ":") + 1;
826 stm32_addr_t start = strtoul(s_start, NULL, 16);
827 unsigned count = strtoul(s_count, NULL, 16);
829 for(int i = 0; i < count; i ++) {
830 char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
831 uint8_t byte = strtoul(hex, NULL, 16);
835 if((count % 4) == 0 && (start % 4) == 0) {
836 stlink_write_mem32(sl, start, count);
838 stlink_write_mem8(sl, start, count);
841 reply = strdup("OK");
848 stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
849 stm32_addr_t len = strtoul(&endptr[1], NULL, 16);
853 if(update_code_breakpoint(sl, addr, 1) < 0) {
854 reply = strdup("E00");
856 reply = strdup("OK");
860 case '2': // insert write watchpoint
861 case '3': // insert read watchpoint
862 case '4': // insert access watchpoint
865 if(packet[1] == '2') {
867 } else if(packet[1] == '3') {
871 if(add_data_watchpoint(sl, wf, addr, len) < 0) {
872 reply = strdup("E00");
874 reply = strdup("OK");
887 stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
888 //stm32_addr_t len = strtoul(&endptr[1], NULL, 16);
891 case '1': // remove breakpoint
892 update_code_breakpoint(sl, addr, 0);
893 reply = strdup("OK");
896 case '2' : // remove write watchpoint
897 case '3' : // remove read watchpoint
898 case '4' : // remove access watchpoint
899 if(delete_data_watchpoint(sl, addr) < 0) {
900 reply = strdup("E00");
902 reply = strdup("OK");
914 * Enter extended mode which allows restarting.
915 * We do support that always.
918 reply = strdup("OK");
924 /* Reset the core. */
927 init_code_breakpoints(sl);
928 init_data_watchpoints(sl);
932 reply = strdup("OK");
943 printf("send: %s\n", reply);
946 int result = gdb_send_packet(client, reply);
948 fprintf(stderr, "cannot send: %d\n", result);