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 // configured for STM32F100RB
23 static const char* const c_memory_map =
24 "<?xml version=\"1.0\"?>"
25 "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
26 " \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
28 " <memory type=\"rom\" start=\"0x00000000\" length=\"0x20000\"/>" // code = sram or flash
29 " <memory type=\"ram\" start=\"0x20000000\" length=\"0x2000\"/>" // sram 8k
30 " <memory type=\"flash\" start=\"0x08000000\" length=\"0x20000\">" // flash 128k
31 " <property name=\"blocksize\">0x400</property>" // 1k pages
33 " <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>" // peripheral regs
34 " <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>" // cortex regs
37 int serve(struct stlink* sl, int port);
39 int main(int argc, char** argv) {
41 fprintf(stderr, "Usage: %s <port> /dev/sgX\n", argv[0]);
45 struct stlink *sl = stlink_quirk_open(argv[2], 0);
49 if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
50 stlink_enter_swd_mode(sl);
53 printf("Debugging ARM core %08x.\n", sl->core_id);
55 int port = atoi(argv[1]);
57 while(serve(sl, port) == 0);
64 #define CODE_BREAK_NUM 6
66 #define CODE_BREAK_LOW 0x01
67 #define CODE_BREAK_HIGH 0x02
69 struct code_hw_breakpoint {
74 struct code_hw_breakpoint code_breaks[CODE_BREAK_NUM];
76 static void init_code_breakpoints(struct stlink* sl) {
77 memset(sl->q_buf, 0, 4);
78 sl->q_buf[0] = 0x03; // KEY | ENABLE
79 stlink_write_mem32(sl, 0xe0002000, 4);
81 memset(sl->q_buf, 0, 4);
82 for(int i = 0; i < CODE_BREAK_NUM; i++) {
83 code_breaks[i].type = 0;
84 stlink_write_mem32(sl, 0xe0002008 + i * 4, 4);
88 static int update_code_breakpoint(struct stlink* sl, stm32_addr_t addr, int set) {
89 stm32_addr_t fpb_addr = addr & ~0x3;
90 int type = addr & 0x2 ? CODE_BREAK_HIGH : CODE_BREAK_LOW;
93 fprintf(stderr, "update_code_breakpoint: unaligned address %08x\n", addr);
98 for(int i = 0; i < CODE_BREAK_NUM; i++) {
99 if(fpb_addr == code_breaks[i].addr ||
100 (set && code_breaks[i].type == 0)) {
107 if(set) return -1; // Free slot not found
108 else return 0; // Breakpoint is already removed
111 struct code_hw_breakpoint* brk = &code_breaks[id];
113 brk->addr = fpb_addr;
115 if(set) brk->type |= type;
116 else brk->type &= ~type;
118 memset(sl->q_buf, 0, 4);
122 printf("clearing hw break %d\n", id);
125 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
127 sl->q_buf[0] = ( brk->addr & 0xff) | 1;
128 sl->q_buf[1] = ((brk->addr >> 8) & 0xff);
129 sl->q_buf[2] = ((brk->addr >> 16) & 0xff);
130 sl->q_buf[3] = ((brk->addr >> 24) & 0xff) | (brk->type << 6);
133 printf("setting hw break %d at %08x (%d)\n",
134 id, brk->addr, brk->type);
135 printf("reg %02x %02x %02x %02x\n",
136 sl->q_buf[3], sl->q_buf[2], sl->q_buf[1], sl->q_buf[0]);
139 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
145 #define FLASH_BASE 0x08000000
146 #define FLASH_PAGE 0x400
147 #define FLASH_PAGE_MASK (~((1 << 10) - 1))
148 #define FLASH_SIZE (FLASH_PAGE * 128)
155 struct flash_block* next;
158 static struct flash_block* flash_root;
160 static int flash_add_block(stm32_addr_t addr, unsigned length) {
161 if(addr < FLASH_BASE || addr + length > FLASH_BASE + FLASH_SIZE) {
162 fprintf(stderr, "flash_add_block: incorrect bounds\n");
166 if(addr % FLASH_PAGE != 0 || length % FLASH_PAGE != 0) {
167 fprintf(stderr, "flash_add_block: unaligned block\n");
171 struct flash_block* new = malloc(sizeof(struct flash_block));
172 new->next = flash_root;
175 new->length = length;
176 new->data = calloc(length, 1);
183 static int flash_populate(stm32_addr_t addr, uint8_t* data, unsigned length) {
184 int fit_blocks = 0, fit_length = 0;
186 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
187 /* Block: ------X------Y--------
191 * Block intersects with data, if:
195 unsigned X = fb->addr, Y = fb->addr + fb->length;
196 unsigned a = addr, b = addr + length;
198 // from start of the block
199 unsigned start = (a > X ? a : X) - X;
200 unsigned end = (b > Y ? Y : b) - X;
202 memcpy(fb->data + start, data, end - start);
205 fit_length += end - start;
209 if(fit_blocks == 0) {
210 fprintf(stderr, "Unfit data block %08x -> %04x\n", addr, length);
214 if(fit_length != length) {
215 fprintf(stderr, "warning: data block %08x -> %04x truncated to %04x\n",
216 addr, length, fit_length);
217 fprintf(stderr, "(this is not an error, just a GDB glitch)\n");
223 static int flash_go(struct stlink* sl) {
226 // Some kinds of clock settings do not allow writing to flash.
229 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
231 printf("flash_do: block %08x -> %04x\n", fb->addr, fb->length);
234 unsigned length = fb->length;
235 for(stm32_addr_t page = fb->addr; page < fb->addr + fb->length; page += 0x400) {
237 printf("flash_do: page %08x\n", page);
240 stlink_erase_flash_page(sl, page);
242 if(stlink_write_flash(sl, page, fb->data + (page - fb->addr),
243 length > 0x400 ? 0x400 : length) < 0)
254 for(struct flash_block* fb = flash_root, *next; fb; fb = next) {
265 int serve(struct stlink* sl, int port) {
266 int sock = socket(AF_INET, SOCK_STREAM, 0);
272 unsigned int val = 1;
273 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
275 struct sockaddr_in serv_addr = {0};
276 serv_addr.sin_family = AF_INET;
277 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
278 serv_addr.sin_port = htons(port);
280 if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
285 if(listen(sock, 5) < 0) {
290 stlink_force_debug(sl);
292 init_code_breakpoints(sl);
294 printf("Listening at *:%d...\n", port);
296 int client = accept(sock, NULL, NULL);
304 printf("GDB connected.\n");
309 int status = gdb_recv_packet(client, &packet);
311 fprintf(stderr, "cannot recv: %d\n", status);
316 printf("recv: %s\n", packet);
323 if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
328 char *separator = strstr(packet, ":"), *params = "";
329 if(separator == NULL) {
330 separator = packet + strlen(packet);
332 params = separator + 1;
335 unsigned queryNameLength = (separator - &packet[1]);
336 char* queryName = calloc(queryNameLength + 1, 1);
337 strncpy(queryName, &packet[1], queryNameLength);
340 printf("query: %s;%s\n", queryName, params);
343 if(!strcmp(queryName, "Supported")) {
344 reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
345 } else if(!strcmp(queryName, "Xfer")) {
346 char *type, *op, *annex, *s_addr, *s_length;
349 type = strsep(&tok, ":");
350 op = strsep(&tok, ":");
351 annex = strsep(&tok, ":");
352 s_addr = strsep(&tok, ",");
355 unsigned addr = strtoul(s_addr, NULL, 16),
356 length = strtoul(s_length, NULL, 16);
359 printf("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
360 type, op, annex, addr, length);
363 const char* data = NULL;
365 if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
369 unsigned data_length = strlen(data);
370 if(addr + length > data_length)
371 length = data_length - addr;
376 reply = calloc(length + 2, 1);
378 strncpy(&reply[1], data, length);
392 char *separator = strstr(packet, ":"), *params = "";
393 if(separator == NULL) {
394 separator = packet + strlen(packet);
396 params = separator + 1;
399 unsigned cmdNameLength = (separator - &packet[1]);
400 char* cmdName = calloc(cmdNameLength + 1, 1);
401 strncpy(cmdName, &packet[1], cmdNameLength);
403 if(!strcmp(cmdName, "FlashErase")) {
404 char *s_addr, *s_length;
407 s_addr = strsep(&tok, ",");
410 unsigned addr = strtoul(s_addr, NULL, 16),
411 length = strtoul(s_length, NULL, 16);
414 printf("FlashErase: addr:%08x,len:%04x\n",
418 if(flash_add_block(addr, length) < 0) {
419 reply = strdup("E00");
421 reply = strdup("OK");
423 } else if(!strcmp(cmdName, "FlashWrite")) {
427 s_addr = strsep(&tok, ":");
430 unsigned addr = strtoul(s_addr, NULL, 16);
431 unsigned data_length = status - (data - packet);
433 // Length of decoded data cannot be more than
434 // encoded, as escapes are removed.
435 // Additional byte is reserved for alignment fix.
436 uint8_t *decoded = calloc(data_length + 1, 1);
437 unsigned dec_index = 0;
438 for(int i = 0; i < data_length; i++) {
439 if(data[i] == 0x7d) {
441 decoded[dec_index++] = data[i] ^ 0x20;
443 decoded[dec_index++] = data[i];
448 if(dec_index % 2 != 0)
452 printf("binary packet %d -> %d\n", data_length, dec_index);
455 if(flash_populate(addr, decoded, dec_index) < 0) {
456 reply = strdup("E00");
458 reply = strdup("OK");
460 } else if(!strcmp(cmdName, "FlashDone")) {
461 if(flash_go(sl) < 0) {
462 reply = strdup("E00");
464 reply = strdup("OK");
480 int status = gdb_check_for_interrupt(client);
482 fprintf(stderr, "cannot check for int: %d\n", status);
487 stlink_force_debug(sl);
492 if(sl->core_stat == STLINK_CORE_HALTED) {
499 reply = strdup("S05"); // TRAP
505 reply = strdup("S05"); // TRAP
509 reply = strdup("S05"); // TRAP
513 stlink_read_all_regs(sl);
515 reply = calloc(8 * 16 + 1, 1);
516 for(int i = 0; i < 16; i++)
517 sprintf(&reply[i * 8], "%08x", htonl(sl->reg.r[i]));
522 unsigned id = strtoul(&packet[1], NULL, 16), reg = 0xDEADDEAD;
525 stlink_read_reg(sl, id);
526 reg = htonl(sl->reg.r[id]);
527 } else if(id == 0x19) {
528 stlink_read_reg(sl, 16);
529 reg = htonl(sl->reg.xpsr);
531 reply = strdup("E00");
534 reply = calloc(8 + 1, 1);
535 sprintf(reply, "%08x", reg);
541 char* s_reg = &packet[1];
542 char* s_value = strstr(&packet[1], "=") + 1;
544 unsigned reg = strtoul(s_reg, NULL, 16);
545 unsigned value = strtoul(s_value, NULL, 16);
548 stlink_write_reg(sl, ntohl(value), reg);
549 } else if(reg == 0x19) {
550 stlink_write_reg(sl, ntohl(value), 16);
552 reply = strdup("E00");
556 reply = strdup("OK");
563 for(int i = 0; i < 16; i++) {
565 strncpy(str, &packet[1 + i * 8], 8);
566 uint32_t reg = strtoul(str, NULL, 16);
567 stlink_write_reg(sl, ntohl(reg), i);
570 reply = strdup("OK");
574 char* s_start = &packet[1];
575 char* s_count = strstr(&packet[1], ",") + 1;
577 stm32_addr_t start = strtoul(s_start, NULL, 16);
578 unsigned count = strtoul(s_count, NULL, 16);
580 unsigned adj_start = start % 4;
582 stlink_read_mem32(sl, start - adj_start, (count % 4 == 0) ?
583 count : count + 4 - (count % 4));
585 reply = calloc(count * 2 + 1, 1);
586 for(int i = 0; i < count; i++) {
587 reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
588 reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
595 char* s_start = &packet[1];
596 char* s_count = strstr(&packet[1], ",") + 1;
597 char* hexdata = strstr(packet, ":") + 1;
599 stm32_addr_t start = strtoul(s_start, NULL, 16);
600 unsigned count = strtoul(s_count, NULL, 16);
602 for(int i = 0; i < count; i ++) {
603 char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
604 uint8_t byte = strtoul(hex, NULL, 16);
608 if((count % 4) == 0 && (start % 4) == 0) {
609 stlink_write_mem32(sl, start, count);
611 stlink_write_mem8(sl, start, count);
614 reply = strdup("OK");
620 if(packet[1] == '1') {
621 stm32_addr_t addr = strtoul(&packet[3], NULL, 16);
622 if(update_code_breakpoint(sl, addr, 1) < 0) {
623 reply = strdup("E00");
625 reply = strdup("OK");
635 if(packet[1] == '1') {
636 stm32_addr_t addr = strtoul(&packet[3], NULL, 16);
637 update_code_breakpoint(sl, addr, 0);
639 reply = strdup("OK");
648 // After this function will be entered afterwards, the
649 // chip will be reset anyway. So this is a no-op.
661 printf("send: %s\n", reply);
664 int result = gdb_send_packet(client, reply);
666 fprintf(stderr, "cannot send: %d\n", result);