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 flash_size_reg;
39 uint32_t max_flash_size, flash_pagesize;
41 uint32_t bootrom_base, bootrom_size;
43 { 0x410, "F1 Medium-density device", 0x1ffff7e0,
44 0x20000, 0x400, 0x5000, 0x1ffff000, 0x800 }, // table 2, pm0063
45 { 0x411, "F2 device", 0, /* No flash size register found in the docs*/
46 0x100000, 0x20000, 0x20000, 0x1ff00000, 0x7800 }, // table 1, pm0059
47 { 0x412, "F1 Low-density device", 0x1ffff7e0,
48 0x8000, 0x400, 0x2800, 0x1ffff000, 0x800 }, // table 1, pm0063
49 { 0x413, "F4 device", 0x1FFF7A10,
50 0x100000, 0x20000, 0x20000, 0x1ff00000, 0x7800 }, // table 1, pm0081
51 { 0x414, "F1 High-density device", 0x1ffff7e0,
52 0x80000, 0x800, 0x10000, 0x1ffff000, 0x800 }, // table 3 pm0063
53 // This ignores the EEPROM! (and uses the page erase size,
54 // not the sector write protection...)
55 { 0x416, "L1 Med-density device", 0x1FF8004C, // table 1, pm0062
56 0x20000, 0x100, 0x4000, 0x1ff00000, 0x1000 },
57 { 0x418, "F1 Connectivity line device", 0x1ffff7e0,
58 0x40000, 0x800, 0x10000, 0x1fffb000, 0x4800 },
59 { 0x420, "F1 Medium-density value line device", 0x1ffff7e0,
60 0x20000, 0x400, 0x2000, 0x1ffff000, 0x800 },
61 { 0x428, "F1 High-density value line device", 0x1ffff7e0,
62 0x80000, 0x800, 0x8000, 0x1ffff000, 0x800 },
63 { 0x430, "F1 XL-density device", 0x1ffff7e0, // pm0068
64 0x100000, 0x800, 0x18000, 0x1fffe000, 0x1800 },
68 int serve(stlink_t *sl, int port);
69 char* make_memory_map(const struct chip_params *params, uint32_t flash_size);
71 int main(int argc, char** argv) {
73 fprintf(stderr, "Usage: %s <port> /dev/sgX\n", argv[0]);
77 // FIXME - hardcoded to usb....
78 stlink_t *sl =stlink_open_usb(argv[2], 10);
82 if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
83 stlink_enter_swd_mode(sl);
85 uint32_t chip_id = stlink_chip_id(sl);
86 printf("Chip ID is %08x.\n", chip_id);
88 const struct chip_params* params = NULL;
90 for(int i = 0; i < sizeof(devices) / sizeof(devices[0]); i++) {
91 if(devices[i].chip_id == (chip_id & 0xFFF)) {
98 fprintf(stderr, "Cannot recognize the connected device!\n");
102 printf("Device connected: %s\n", params->description);
103 printf("Device parameters: SRAM: 0x%x bytes, Flash: up to 0x%x bytes in pages of 0x%x bytes\n",
104 params->sram_size, params->max_flash_size, params->flash_pagesize);
106 FLASH_PAGE = params->flash_pagesize;
110 stlink_read_mem32(sl, params->flash_size_reg, 4);
111 flash_size = sl->q_buf[0] | (sl->q_buf[1] << 8);
113 printf("Flash size is %d KiB.\n", flash_size);
114 // memory map is in 1k blocks.
115 current_memory_map = make_memory_map(params, flash_size * 0x400);
117 int port = atoi(argv[1]);
119 while(serve(sl, port) == 0);
126 static const char* const memory_map_template =
127 "<?xml version=\"1.0\"?>"
128 "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
129 " \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
131 " <memory type=\"rom\" start=\"0x00000000\" length=\"0x%x\"/>" // code = sram, bootrom or flash; flash is bigger
132 " <memory type=\"ram\" start=\"0x20000000\" length=\"0x%x\"/>" // sram 8k
133 " <memory type=\"flash\" start=\"0x08000000\" length=\"0x%x\">"
134 " <property name=\"blocksize\">0x%x</property>"
136 " <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>" // peripheral regs
137 " <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>" // cortex regs
138 " <memory type=\"rom\" start=\"0x%08x\" length=\"0x%x\"/>" // bootrom
139 " <memory type=\"rom\" start=\"0x1ffff800\" length=\"0x8\"/>" // option byte area
142 char* make_memory_map(const struct chip_params *params, uint32_t flash_size) {
143 /* This will be freed in serve() */
144 char* map = malloc(4096);
147 snprintf(map, 4096, memory_map_template,
150 flash_size, params->flash_pagesize,
151 params->bootrom_base, params->bootrom_size);
158 * DWT_COMP0 0xE0001020
159 * DWT_MASK0 0xE0001024
160 * DWT_FUNCTION0 0xE0001028
161 * DWT_COMP1 0xE0001030
162 * DWT_MASK1 0xE0001034
163 * DWT_FUNCTION1 0xE0001038
164 * DWT_COMP2 0xE0001040
165 * DWT_MASK2 0xE0001044
166 * DWT_FUNCTION2 0xE0001048
167 * DWT_COMP3 0xE0001050
168 * DWT_MASK3 0xE0001054
169 * DWT_FUNCTION3 0xE0001058
172 #define DATA_WATCH_NUM 4
174 enum watchfun { WATCHDISABLED = 0, WATCHREAD = 5, WATCHWRITE = 6, WATCHACCESS = 7 };
176 struct code_hw_watchpoint {
182 struct code_hw_watchpoint data_watches[DATA_WATCH_NUM];
184 static void init_data_watchpoints(stlink_t *sl) {
186 printf("init watchpoints\n");
189 // set trcena in debug command to turn on dwt unit
190 stlink_read_mem32(sl, 0xE000EDFC, 4);
192 stlink_write_mem32(sl, 0xE000EDFC, 4);
194 // make sure all watchpoints are cleared
195 memset(sl->q_buf, 0, 4);
196 for(int i = 0; i < DATA_WATCH_NUM; i++) {
197 data_watches[i].fun = WATCHDISABLED;
198 stlink_write_mem32(sl, 0xe0001028 + i * 16, 4);
202 static int add_data_watchpoint(stlink_t *sl, enum watchfun wf, stm32_addr_t addr, unsigned int len)
208 // find a free watchpoint
218 if((mask != -1) && (mask < 16)) {
219 for(i = 0; i < DATA_WATCH_NUM; i++) {
220 // is this an empty slot ?
221 if(data_watches[i].fun == WATCHDISABLED) {
223 printf("insert watchpoint %d addr %x wf %u mask %u len %d\n", i, addr, wf, mask, len);
226 data_watches[i].fun = wf;
227 data_watches[i].addr = addr;
228 data_watches[i].mask = mask;
230 // insert comparator address
231 sl->q_buf[0] = (addr & 0xff);
232 sl->q_buf[1] = ((addr >> 8) & 0xff);
233 sl->q_buf[2] = ((addr >> 16) & 0xff);
234 sl->q_buf[3] = ((addr >> 24) & 0xff);
236 stlink_write_mem32(sl, 0xE0001020 + i * 16, 4);
239 memset(sl->q_buf, 0, 4);
241 stlink_write_mem32(sl, 0xE0001024 + i * 16, 4);
244 memset(sl->q_buf, 0, 4);
246 stlink_write_mem32(sl, 0xE0001028 + i * 16, 4);
248 // just to make sure the matched bit is clear !
249 stlink_read_mem32(sl, 0xE0001028 + i * 16, 4);
256 printf("failure: add watchpoints addr %x wf %u len %u\n", addr, wf, len);
261 static int delete_data_watchpoint(stlink_t *sl, stm32_addr_t addr)
265 for(i = 0 ; i < DATA_WATCH_NUM; i++) {
266 if((data_watches[i].addr == addr) && (data_watches[i].fun != WATCHDISABLED)) {
268 printf("delete watchpoint %d addr %x\n", i, addr);
271 memset(sl->q_buf, 0, 4);
272 data_watches[i].fun = WATCHDISABLED;
273 stlink_write_mem32(sl, 0xe0001028 + i * 16, 4);
280 printf("failure: delete watchpoint addr %x\n", addr);
286 #define CODE_BREAK_NUM 6
287 #define CODE_BREAK_LOW 0x01
288 #define CODE_BREAK_HIGH 0x02
290 struct code_hw_breakpoint {
295 struct code_hw_breakpoint code_breaks[CODE_BREAK_NUM];
297 static void init_code_breakpoints(stlink_t *sl) {
298 memset(sl->q_buf, 0, 4);
299 sl->q_buf[0] = 0x03; // KEY | ENABLE
300 stlink_write_mem32(sl, 0xe0002000, 4);
302 memset(sl->q_buf, 0, 4);
303 for(int i = 0; i < CODE_BREAK_NUM; i++) {
304 code_breaks[i].type = 0;
305 stlink_write_mem32(sl, 0xe0002008 + i * 4, 4);
309 static int update_code_breakpoint(stlink_t *sl, stm32_addr_t addr, int set) {
310 stm32_addr_t fpb_addr = addr & ~0x3;
311 int type = addr & 0x2 ? CODE_BREAK_HIGH : CODE_BREAK_LOW;
314 fprintf(stderr, "update_code_breakpoint: unaligned address %08x\n", addr);
319 for(int i = 0; i < CODE_BREAK_NUM; i++) {
320 if(fpb_addr == code_breaks[i].addr ||
321 (set && code_breaks[i].type == 0)) {
328 if(set) return -1; // Free slot not found
329 else return 0; // Breakpoint is already removed
332 struct code_hw_breakpoint* brk = &code_breaks[id];
334 brk->addr = fpb_addr;
336 if(set) brk->type |= type;
337 else brk->type &= ~type;
339 memset(sl->q_buf, 0, 4);
343 printf("clearing hw break %d\n", id);
346 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
348 sl->q_buf[0] = ( brk->addr & 0xff) | 1;
349 sl->q_buf[1] = ((brk->addr >> 8) & 0xff);
350 sl->q_buf[2] = ((brk->addr >> 16) & 0xff);
351 sl->q_buf[3] = ((brk->addr >> 24) & 0xff) | (brk->type << 6);
354 printf("setting hw break %d at %08x (%d)\n",
355 id, brk->addr, brk->type);
356 printf("reg %02x %02x %02x %02x\n",
357 sl->q_buf[3], sl->q_buf[2], sl->q_buf[1], sl->q_buf[0]);
360 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
372 struct flash_block* next;
375 static struct flash_block* flash_root;
377 static int flash_add_block(stm32_addr_t addr, unsigned length,
379 if(addr < FLASH_BASE || addr + length > FLASH_BASE + FLASH_SIZE) {
380 fprintf(stderr, "flash_add_block: incorrect bounds\n");
384 if(addr % FLASH_PAGE != 0 || length % FLASH_PAGE != 0) {
385 fprintf(stderr, "flash_add_block: unaligned block\n");
389 struct flash_block* new = malloc(sizeof(struct flash_block));
390 new->next = flash_root;
393 new->length = length;
394 new->data = calloc(length, 1);
401 static int flash_populate(stm32_addr_t addr, uint8_t* data, unsigned length) {
402 int fit_blocks = 0, fit_length = 0;
404 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
405 /* Block: ------X------Y--------
409 * Block intersects with data, if:
413 unsigned X = fb->addr, Y = fb->addr + fb->length;
414 unsigned a = addr, b = addr + length;
416 // from start of the block
417 unsigned start = (a > X ? a : X) - X;
418 unsigned end = (b > Y ? Y : b) - X;
420 memcpy(fb->data + start, data, end - start);
423 fit_length += end - start;
427 if(fit_blocks == 0) {
428 fprintf(stderr, "Unfit data block %08x -> %04x\n", addr, length);
432 if(fit_length != length) {
433 fprintf(stderr, "warning: data block %08x -> %04x truncated to %04x\n",
434 addr, length, fit_length);
435 fprintf(stderr, "(this is not an error, just a GDB glitch)\n");
441 static int flash_go(stlink_t *sl) {
444 // Some kinds of clock settings do not allow writing to flash.
447 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
449 printf("flash_do: block %08x -> %04x\n", fb->addr, fb->length);
452 unsigned length = fb->length;
453 for(stm32_addr_t page = fb->addr; page < fb->addr + fb->length; page += FLASH_PAGE) {
455 printf("flash_do: page %08x\n", page);
458 stlink_erase_flash_page(sl, page);
460 if(stlink_write_flash(sl, page, fb->data + (page - fb->addr),
461 length > FLASH_PAGE ? FLASH_PAGE : length) < 0)
472 for(struct flash_block* fb = flash_root, *next; fb; fb = next) {
483 int serve(stlink_t *sl, int port) {
484 int sock = socket(AF_INET, SOCK_STREAM, 0);
490 unsigned int val = 1;
491 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
493 struct sockaddr_in serv_addr = {0};
494 serv_addr.sin_family = AF_INET;
495 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
496 serv_addr.sin_port = htons(port);
498 if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
503 if(listen(sock, 5) < 0) {
508 stlink_force_debug(sl);
510 init_code_breakpoints(sl);
511 init_data_watchpoints(sl);
513 printf("Listening at *:%d...\n", port);
515 int client = accept(sock, NULL, NULL);
523 printf("GDB connected.\n");
526 * To allow resetting the chip from GDB it is required to
527 * emulate attaching and detaching to target.
529 unsigned int attached = 1;
534 int status = gdb_recv_packet(client, &packet);
536 fprintf(stderr, "cannot recv: %d\n", status);
541 printf("recv: %s\n", packet);
549 if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
554 char *separator = strstr(packet, ":"), *params = "";
555 if(separator == NULL) {
556 separator = packet + strlen(packet);
558 params = separator + 1;
561 unsigned queryNameLength = (separator - &packet[1]);
562 char* queryName = calloc(queryNameLength + 1, 1);
563 strncpy(queryName, &packet[1], queryNameLength);
566 printf("query: %s;%s\n", queryName, params);
569 if(!strcmp(queryName, "Supported")) {
570 reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
571 } else if(!strcmp(queryName, "Xfer")) {
572 char *type, *op, *annex, *s_addr, *s_length;
575 type = strsep(&tok, ":");
576 op = strsep(&tok, ":");
577 annex = strsep(&tok, ":");
578 s_addr = strsep(&tok, ",");
581 unsigned addr = strtoul(s_addr, NULL, 16),
582 length = strtoul(s_length, NULL, 16);
585 printf("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
586 type, op, annex, addr, length);
589 const char* data = NULL;
591 if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
592 data = current_memory_map;
595 unsigned data_length = strlen(data);
596 if(addr + length > data_length)
597 length = data_length - addr;
602 reply = calloc(length + 2, 1);
604 strncpy(&reply[1], data, length);
619 char *cmdName = strtok_r(packet, ":;", ¶ms);
621 cmdName++; // vCommand -> Command
623 if(!strcmp(cmdName, "FlashErase")) {
624 char *s_addr, *s_length;
627 s_addr = strsep(&tok, ",");
630 unsigned addr = strtoul(s_addr, NULL, 16),
631 length = strtoul(s_length, NULL, 16);
634 printf("FlashErase: addr:%08x,len:%04x\n",
638 if(flash_add_block(addr, length, sl) < 0) {
639 reply = strdup("E00");
641 reply = strdup("OK");
643 } else if(!strcmp(cmdName, "FlashWrite")) {
647 s_addr = strsep(&tok, ":");
650 unsigned addr = strtoul(s_addr, NULL, 16);
651 unsigned data_length = status - (data - packet);
653 // Length of decoded data cannot be more than
654 // encoded, as escapes are removed.
655 // Additional byte is reserved for alignment fix.
656 uint8_t *decoded = calloc(data_length + 1, 1);
657 unsigned dec_index = 0;
658 for(int i = 0; i < data_length; i++) {
659 if(data[i] == 0x7d) {
661 decoded[dec_index++] = data[i] ^ 0x20;
663 decoded[dec_index++] = data[i];
668 if(dec_index % 2 != 0)
672 printf("binary packet %d -> %d\n", data_length, dec_index);
675 if(flash_populate(addr, decoded, dec_index) < 0) {
676 reply = strdup("E00");
678 reply = strdup("OK");
680 } else if(!strcmp(cmdName, "FlashDone")) {
681 if(flash_go(sl) < 0) {
682 reply = strdup("E00");
684 reply = strdup("OK");
686 } else if(!strcmp(cmdName, "Kill")) {
689 reply = strdup("OK");
702 int status = gdb_check_for_interrupt(client);
704 fprintf(stderr, "cannot check for int: %d\n", status);
709 stlink_force_debug(sl);
714 if(sl->core_stat == STLINK_CORE_HALTED) {
721 reply = strdup("S05"); // TRAP
727 reply = strdup("S05"); // TRAP
732 reply = strdup("S05"); // TRAP
734 /* Stub shall reply OK if not attached. */
735 reply = strdup("OK");
740 stlink_read_all_regs(sl, ®p);
742 reply = calloc(8 * 16 + 1, 1);
743 for(int i = 0; i < 16; i++)
744 sprintf(&reply[i * 8], "%08x", htonl(regp.r[i]));
749 unsigned id = strtoul(&packet[1], NULL, 16);
750 unsigned myreg = 0xDEADDEAD;
753 stlink_read_reg(sl, id, ®p);
754 myreg = htonl(regp.r[id]);
755 } else if(id == 0x19) {
756 stlink_read_reg(sl, 16, ®p);
757 myreg = htonl(regp.xpsr);
759 reply = strdup("E00");
762 reply = calloc(8 + 1, 1);
763 sprintf(reply, "%08x", myreg);
769 char* s_reg = &packet[1];
770 char* s_value = strstr(&packet[1], "=") + 1;
772 unsigned reg = strtoul(s_reg, NULL, 16);
773 unsigned value = strtoul(s_value, NULL, 16);
776 stlink_write_reg(sl, ntohl(value), reg);
777 } else if(reg == 0x19) {
778 stlink_write_reg(sl, ntohl(value), 16);
780 reply = strdup("E00");
784 reply = strdup("OK");
791 for(int i = 0; i < 16; i++) {
793 strncpy(str, &packet[1 + i * 8], 8);
794 uint32_t reg = strtoul(str, NULL, 16);
795 stlink_write_reg(sl, ntohl(reg), i);
798 reply = strdup("OK");
802 char* s_start = &packet[1];
803 char* s_count = strstr(&packet[1], ",") + 1;
805 stm32_addr_t start = strtoul(s_start, NULL, 16);
806 unsigned count = strtoul(s_count, NULL, 16);
808 unsigned adj_start = start % 4;
810 stlink_read_mem32(sl, start - adj_start, (count % 4 == 0) ?
811 count : count + 4 - (count % 4));
813 reply = calloc(count * 2 + 1, 1);
814 for(int i = 0; i < count; i++) {
815 reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
816 reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
823 char* s_start = &packet[1];
824 char* s_count = strstr(&packet[1], ",") + 1;
825 char* hexdata = strstr(packet, ":") + 1;
827 stm32_addr_t start = strtoul(s_start, NULL, 16);
828 unsigned count = strtoul(s_count, NULL, 16);
830 for(int i = 0; i < count; i ++) {
831 char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
832 uint8_t byte = strtoul(hex, NULL, 16);
836 if((count % 4) == 0 && (start % 4) == 0) {
837 stlink_write_mem32(sl, start, count);
839 stlink_write_mem8(sl, start, count);
842 reply = strdup("OK");
849 stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
850 stm32_addr_t len = strtoul(&endptr[1], NULL, 16);
854 if(update_code_breakpoint(sl, addr, 1) < 0) {
855 reply = strdup("E00");
857 reply = strdup("OK");
861 case '2': // insert write watchpoint
862 case '3': // insert read watchpoint
863 case '4': // insert access watchpoint
866 if(packet[1] == '2') {
868 } else if(packet[1] == '3') {
872 if(add_data_watchpoint(sl, wf, addr, len) < 0) {
873 reply = strdup("E00");
875 reply = strdup("OK");
888 stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
889 //stm32_addr_t len = strtoul(&endptr[1], NULL, 16);
892 case '1': // remove breakpoint
893 update_code_breakpoint(sl, addr, 0);
894 reply = strdup("OK");
897 case '2' : // remove write watchpoint
898 case '3' : // remove read watchpoint
899 case '4' : // remove access watchpoint
900 if(delete_data_watchpoint(sl, addr) < 0) {
901 reply = strdup("E00");
903 reply = strdup("OK");
915 * Enter extended mode which allows restarting.
916 * We do support that always.
919 reply = strdup("OK");
925 /* Reset the core. */
928 init_code_breakpoints(sl);
929 init_data_watchpoints(sl);
933 reply = strdup("OK");
944 printf("send: %s\n", reply);
947 int result = gdb_send_packet(client, reply);
949 fprintf(stderr, "cannot send: %d\n", result);