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>
17 #include "gdb-remote.h"
18 #include "stlink-hw.h"
20 static const char hex[] = "0123456789abcdef";
22 static const char* current_memory_map = NULL;
27 uint32_t flash_base, flash_size, flash_pagesize;
28 uint32_t bootrom_base, bootrom_size;
29 uint32_t sram_base, sram_size;
31 { 0x10016420, "STM32F100 on Discovery",
32 0x08000000, 128 * 1024, 1024,
34 0x20000000, 8 * 1024},
35 { 0x10016412, "Low-density device",
36 0x08000000, 32 * 1024, 1024,
38 0x20000000, 4 * 1024},
39 { 0x10016410, "Medium-density device",
40 0x08000000, 128 * 1024, 1024,
42 0x20000000, 8 * 1024},
43 { 0x10016414, "High-density device",
44 0x08000000, 512 * 1024, 1024,
46 0x20000000, 8 * 1024},
47 { 0x10016430, "XL-density device",
48 0x08000000, 1024 * 1024, 2048,
50 0x20000000, 8 * 1024},
51 { 0x10016418, "Connectivity line device",
52 0x08000000, 256 * 1024, 2048,
53 0x1fffb000, 18 * 1024,
54 0x20000000, 8 * 1024},
58 int serve(struct stlink* sl, int port);
59 char* make_memory_map(const struct chip_params *params);
61 int main(int argc, char** argv) {
63 fprintf(stderr, "Usage: %s <port> /dev/sgX\n", argv[0]);
67 struct stlink *sl = stlink_quirk_open(argv[2], 0);
71 if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
72 stlink_enter_swd_mode(sl);
76 stlink_read_mem32(sl, 0xE0042000, 4);
77 chip_id = sl->q_buf[0] | (sl->q_buf[1] << 8) | (sl->q_buf[2] << 16) |
80 printf("Chip ID is %08x.\n", chip_id);
82 const struct chip_params* params = NULL;
84 for(int i = 0; i < sizeof(devices) / sizeof(devices[0]); i++) {
85 if(devices[i].chip_id == chip_id) {
92 fprintf(stderr, "Cannot recognize the connected device!\n");
96 printf("Device connected: %s\n", params->description);
97 printf("Device parameters: SRAM @%08x: %x, Flash @%08x: %x (pages of %x bytes), Boot ROM: @%08x, %x\n",
98 params->sram_base, params->sram_size,
99 params->flash_base, params->flash_size, params->flash_pagesize,
100 params->bootrom_base, params->bootrom_size);
102 current_memory_map = make_memory_map(params);
104 int port = atoi(argv[1]);
106 while(serve(sl, port) == 0);
113 static const char* const memory_map_template =
114 "<?xml version=\"1.0\"?>"
115 "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
116 " \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
118 " <memory type=\"rom\" start=\"0x00000000\" length=\"0x%x\"/>" // code = sram, bootrom or flash; flash is bigger
119 " <memory type=\"ram\" start=\"0x%08x\" length=\"0x%x\"/>" // sram 8k
120 " <memory type=\"flash\" start=\"0x%08x\" length=\"0x%x\">"
121 " <property name=\"blocksize\">0x%x</property>"
123 " <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>" // peripheral regs
124 " <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>" // cortex regs
125 " <memory type=\"rom\" start=\"0x%08x\" length=\"0x%x\"/>" // bootrom
128 char* make_memory_map(const struct chip_params *params) {
129 /* This will be freed in serve() */
130 char* map = malloc(4096);
133 snprintf(map, 4096, memory_map_template,
135 params->sram_base, params->sram_size,
136 params->flash_base, params->flash_size, params->flash_pagesize,
137 params->bootrom_base, params->bootrom_size);
142 #define CODE_BREAK_NUM 6
144 #define CODE_BREAK_LOW 0x01
145 #define CODE_BREAK_HIGH 0x02
147 struct code_hw_breakpoint {
152 struct code_hw_breakpoint code_breaks[CODE_BREAK_NUM];
154 static void init_code_breakpoints(struct stlink* sl) {
155 memset(sl->q_buf, 0, 4);
156 sl->q_buf[0] = 0x03; // KEY | ENABLE
157 stlink_write_mem32(sl, 0xe0002000, 4);
159 memset(sl->q_buf, 0, 4);
160 for(int i = 0; i < CODE_BREAK_NUM; i++) {
161 code_breaks[i].type = 0;
162 stlink_write_mem32(sl, 0xe0002008 + i * 4, 4);
166 static int update_code_breakpoint(struct stlink* sl, stm32_addr_t addr, int set) {
167 stm32_addr_t fpb_addr = addr & ~0x3;
168 int type = addr & 0x2 ? CODE_BREAK_HIGH : CODE_BREAK_LOW;
171 fprintf(stderr, "update_code_breakpoint: unaligned address %08x\n", addr);
176 for(int i = 0; i < CODE_BREAK_NUM; i++) {
177 if(fpb_addr == code_breaks[i].addr ||
178 (set && code_breaks[i].type == 0)) {
185 if(set) return -1; // Free slot not found
186 else return 0; // Breakpoint is already removed
189 struct code_hw_breakpoint* brk = &code_breaks[id];
191 brk->addr = fpb_addr;
193 if(set) brk->type |= type;
194 else brk->type &= ~type;
196 memset(sl->q_buf, 0, 4);
200 printf("clearing hw break %d\n", id);
203 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
205 sl->q_buf[0] = ( brk->addr & 0xff) | 1;
206 sl->q_buf[1] = ((brk->addr >> 8) & 0xff);
207 sl->q_buf[2] = ((brk->addr >> 16) & 0xff);
208 sl->q_buf[3] = ((brk->addr >> 24) & 0xff) | (brk->type << 6);
211 printf("setting hw break %d at %08x (%d)\n",
212 id, brk->addr, brk->type);
213 printf("reg %02x %02x %02x %02x\n",
214 sl->q_buf[3], sl->q_buf[2], sl->q_buf[1], sl->q_buf[0]);
217 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
223 #define FLASH_BASE 0x08000000
224 #define FLASH_PAGE 0x400
225 #define FLASH_PAGE_MASK (~((1 << 10) - 1))
226 #define FLASH_SIZE (FLASH_PAGE * 128)
233 struct flash_block* next;
236 static struct flash_block* flash_root;
238 static int flash_add_block(stm32_addr_t addr, unsigned length) {
239 if(addr < FLASH_BASE || addr + length > FLASH_BASE + FLASH_SIZE) {
240 fprintf(stderr, "flash_add_block: incorrect bounds\n");
244 if(addr % FLASH_PAGE != 0 || length % FLASH_PAGE != 0) {
245 fprintf(stderr, "flash_add_block: unaligned block\n");
249 struct flash_block* new = malloc(sizeof(struct flash_block));
250 new->next = flash_root;
253 new->length = length;
254 new->data = calloc(length, 1);
261 static int flash_populate(stm32_addr_t addr, uint8_t* data, unsigned length) {
262 int fit_blocks = 0, fit_length = 0;
264 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
265 /* Block: ------X------Y--------
269 * Block intersects with data, if:
273 unsigned X = fb->addr, Y = fb->addr + fb->length;
274 unsigned a = addr, b = addr + length;
276 // from start of the block
277 unsigned start = (a > X ? a : X) - X;
278 unsigned end = (b > Y ? Y : b) - X;
280 memcpy(fb->data + start, data, end - start);
283 fit_length += end - start;
287 if(fit_blocks == 0) {
288 fprintf(stderr, "Unfit data block %08x -> %04x\n", addr, length);
292 if(fit_length != length) {
293 fprintf(stderr, "warning: data block %08x -> %04x truncated to %04x\n",
294 addr, length, fit_length);
295 fprintf(stderr, "(this is not an error, just a GDB glitch)\n");
301 static int flash_go(struct stlink* sl) {
304 // Some kinds of clock settings do not allow writing to flash.
307 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
309 printf("flash_do: block %08x -> %04x\n", fb->addr, fb->length);
312 unsigned length = fb->length;
313 for(stm32_addr_t page = fb->addr; page < fb->addr + fb->length; page += 0x400) {
315 printf("flash_do: page %08x\n", page);
318 stlink_erase_flash_page(sl, page);
320 if(stlink_write_flash(sl, page, fb->data + (page - fb->addr),
321 length > 0x400 ? 0x400 : length) < 0)
332 for(struct flash_block* fb = flash_root, *next; fb; fb = next) {
343 int serve(struct stlink* sl, int port) {
344 int sock = socket(AF_INET, SOCK_STREAM, 0);
350 unsigned int val = 1;
351 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
353 struct sockaddr_in serv_addr = {0};
354 serv_addr.sin_family = AF_INET;
355 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
356 serv_addr.sin_port = htons(port);
358 if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
363 if(listen(sock, 5) < 0) {
368 stlink_force_debug(sl);
370 init_code_breakpoints(sl);
372 printf("Listening at *:%d...\n", port);
374 int client = accept(sock, NULL, NULL);
382 printf("GDB connected.\n");
385 * To allow resetting the chip from GDB it is required to
386 * emulate attaching and detaching to target.
388 unsigned int attached = 1;
393 int status = gdb_recv_packet(client, &packet);
395 fprintf(stderr, "cannot recv: %d\n", status);
400 printf("recv: %s\n", packet);
407 if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
412 char *separator = strstr(packet, ":"), *params = "";
413 if(separator == NULL) {
414 separator = packet + strlen(packet);
416 params = separator + 1;
419 unsigned queryNameLength = (separator - &packet[1]);
420 char* queryName = calloc(queryNameLength + 1, 1);
421 strncpy(queryName, &packet[1], queryNameLength);
424 printf("query: %s;%s\n", queryName, params);
427 if(!strcmp(queryName, "Supported")) {
428 reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
429 } else if(!strcmp(queryName, "Xfer")) {
430 char *type, *op, *annex, *s_addr, *s_length;
433 type = strsep(&tok, ":");
434 op = strsep(&tok, ":");
435 annex = strsep(&tok, ":");
436 s_addr = strsep(&tok, ",");
439 unsigned addr = strtoul(s_addr, NULL, 16),
440 length = strtoul(s_length, NULL, 16);
443 printf("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
444 type, op, annex, addr, length);
447 const char* data = NULL;
449 if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
450 data = current_memory_map;
453 unsigned data_length = strlen(data);
454 if(addr + length > data_length)
455 length = data_length - addr;
460 reply = calloc(length + 2, 1);
462 strncpy(&reply[1], data, length);
477 char *cmdName = strtok_r(packet, ":;", ¶ms);
479 cmdName++; // vCommand -> Command
481 if(!strcmp(cmdName, "FlashErase")) {
482 char *s_addr, *s_length;
485 s_addr = strsep(&tok, ",");
488 unsigned addr = strtoul(s_addr, NULL, 16),
489 length = strtoul(s_length, NULL, 16);
492 printf("FlashErase: addr:%08x,len:%04x\n",
496 if(flash_add_block(addr, length) < 0) {
497 reply = strdup("E00");
499 reply = strdup("OK");
501 } else if(!strcmp(cmdName, "FlashWrite")) {
505 s_addr = strsep(&tok, ":");
508 unsigned addr = strtoul(s_addr, NULL, 16);
509 unsigned data_length = status - (data - packet);
511 // Length of decoded data cannot be more than
512 // encoded, as escapes are removed.
513 // Additional byte is reserved for alignment fix.
514 uint8_t *decoded = calloc(data_length + 1, 1);
515 unsigned dec_index = 0;
516 for(int i = 0; i < data_length; i++) {
517 if(data[i] == 0x7d) {
519 decoded[dec_index++] = data[i] ^ 0x20;
521 decoded[dec_index++] = data[i];
526 if(dec_index % 2 != 0)
530 printf("binary packet %d -> %d\n", data_length, dec_index);
533 if(flash_populate(addr, decoded, dec_index) < 0) {
534 reply = strdup("E00");
536 reply = strdup("OK");
538 } else if(!strcmp(cmdName, "FlashDone")) {
539 if(flash_go(sl) < 0) {
540 reply = strdup("E00");
542 reply = strdup("OK");
544 } else if(!strcmp(cmdName, "Kill")) {
547 reply = strdup("OK");
560 int status = gdb_check_for_interrupt(client);
562 fprintf(stderr, "cannot check for int: %d\n", status);
567 stlink_force_debug(sl);
572 if(sl->core_stat == STLINK_CORE_HALTED) {
579 reply = strdup("S05"); // TRAP
585 reply = strdup("S05"); // TRAP
590 reply = strdup("S05"); // TRAP
592 /* Stub shall reply OK if not attached. */
593 reply = strdup("OK");
598 stlink_read_all_regs(sl);
600 reply = calloc(8 * 16 + 1, 1);
601 for(int i = 0; i < 16; i++)
602 sprintf(&reply[i * 8], "%08x", htonl(sl->reg.r[i]));
607 unsigned id = strtoul(&packet[1], NULL, 16), reg = 0xDEADDEAD;
610 stlink_read_reg(sl, id);
611 reg = htonl(sl->reg.r[id]);
612 } else if(id == 0x19) {
613 stlink_read_reg(sl, 16);
614 reg = htonl(sl->reg.xpsr);
616 reply = strdup("E00");
619 reply = calloc(8 + 1, 1);
620 sprintf(reply, "%08x", reg);
626 char* s_reg = &packet[1];
627 char* s_value = strstr(&packet[1], "=") + 1;
629 unsigned reg = strtoul(s_reg, NULL, 16);
630 unsigned value = strtoul(s_value, NULL, 16);
633 stlink_write_reg(sl, ntohl(value), reg);
634 } else if(reg == 0x19) {
635 stlink_write_reg(sl, ntohl(value), 16);
637 reply = strdup("E00");
641 reply = strdup("OK");
648 for(int i = 0; i < 16; i++) {
650 strncpy(str, &packet[1 + i * 8], 8);
651 uint32_t reg = strtoul(str, NULL, 16);
652 stlink_write_reg(sl, ntohl(reg), i);
655 reply = strdup("OK");
659 char* s_start = &packet[1];
660 char* s_count = strstr(&packet[1], ",") + 1;
662 stm32_addr_t start = strtoul(s_start, NULL, 16);
663 unsigned count = strtoul(s_count, NULL, 16);
665 unsigned adj_start = start % 4;
667 stlink_read_mem32(sl, start - adj_start, (count % 4 == 0) ?
668 count : count + 4 - (count % 4));
670 reply = calloc(count * 2 + 1, 1);
671 for(int i = 0; i < count; i++) {
672 reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
673 reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
680 char* s_start = &packet[1];
681 char* s_count = strstr(&packet[1], ",") + 1;
682 char* hexdata = strstr(packet, ":") + 1;
684 stm32_addr_t start = strtoul(s_start, NULL, 16);
685 unsigned count = strtoul(s_count, NULL, 16);
687 for(int i = 0; i < count; i ++) {
688 char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
689 uint8_t byte = strtoul(hex, NULL, 16);
693 if((count % 4) == 0 && (start % 4) == 0) {
694 stlink_write_mem32(sl, start, count);
696 stlink_write_mem8(sl, start, count);
699 reply = strdup("OK");
705 if(packet[1] == '1') {
706 stm32_addr_t addr = strtoul(&packet[3], NULL, 16);
707 if(update_code_breakpoint(sl, addr, 1) < 0) {
708 reply = strdup("E00");
710 reply = strdup("OK");
720 if(packet[1] == '1') {
721 stm32_addr_t addr = strtoul(&packet[3], NULL, 16);
722 update_code_breakpoint(sl, addr, 0);
724 reply = strdup("OK");
734 * Enter extended mode which allows restarting.
735 * We do support that always.
738 reply = strdup("OK");
744 /* Reset the core. */
747 init_code_breakpoints(sl);
751 reply = strdup("OK");
762 printf("send: %s\n", reply);
765 int result = gdb_send_packet(client, reply);
767 fprintf(stderr, "cannot send: %d\n", result);