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 stlink_erase_flash_page(sl, fb->addr);
236 if(!stlink_write_flash(sl, fb->addr, fb->data, fb->length) < 0) {
237 fprintf(stderr, "Flash writing failed.\n");
247 for(struct flash_block* fb = flash_root, *next; fb; fb = next) {
258 int serve(struct stlink* sl, int port) {
259 int sock = socket(AF_INET, SOCK_STREAM, 0);
265 unsigned int val = 1;
266 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
268 struct sockaddr_in serv_addr = {0};
269 serv_addr.sin_family = AF_INET;
270 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
271 serv_addr.sin_port = htons(port);
273 if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
278 if(listen(sock, 5) < 0) {
283 stlink_force_debug(sl);
285 init_code_breakpoints(sl);
287 printf("Listening at *:%d...\n", port);
289 int client = accept(sock, NULL, NULL);
297 printf("GDB connected.\n");
302 int status = gdb_recv_packet(client, &packet);
304 fprintf(stderr, "cannot recv: %d\n", status);
309 printf("recv: %s\n", packet);
316 if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
321 char *separator = strstr(packet, ":"), *params = "";
322 if(separator == NULL) {
323 separator = packet + strlen(packet);
325 params = separator + 1;
328 unsigned queryNameLength = (separator - &packet[1]);
329 char* queryName = calloc(queryNameLength + 1, 1);
330 strncpy(queryName, &packet[1], queryNameLength);
333 printf("query: %s;%s\n", queryName, params);
336 if(!strcmp(queryName, "Supported")) {
337 reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
338 } else if(!strcmp(queryName, "Xfer")) {
339 char *type, *op, *annex, *s_addr, *s_length;
342 type = strsep(&tok, ":");
343 op = strsep(&tok, ":");
344 annex = strsep(&tok, ":");
345 s_addr = strsep(&tok, ",");
348 unsigned addr = strtoul(s_addr, NULL, 16),
349 length = strtoul(s_length, NULL, 16);
352 printf("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
353 type, op, annex, addr, length);
356 const char* data = NULL;
358 if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
362 unsigned data_length = strlen(data);
363 if(addr + length > data_length)
364 length = data_length - addr;
369 reply = calloc(length + 2, 1);
371 strncpy(&reply[1], data, length);
385 char *separator = strstr(packet, ":"), *params = "";
386 if(separator == NULL) {
387 separator = packet + strlen(packet);
389 params = separator + 1;
392 unsigned cmdNameLength = (separator - &packet[1]);
393 char* cmdName = calloc(cmdNameLength + 1, 1);
394 strncpy(cmdName, &packet[1], cmdNameLength);
396 if(!strcmp(cmdName, "FlashErase")) {
397 char *s_addr, *s_length;
400 s_addr = strsep(&tok, ",");
403 unsigned addr = strtoul(s_addr, NULL, 16),
404 length = strtoul(s_length, NULL, 16);
407 printf("FlashErase: addr:%08x,len:%04x\n",
411 if(flash_add_block(addr, length) < 0) {
412 reply = strdup("E00");
414 reply = strdup("OK");
416 } else if(!strcmp(cmdName, "FlashWrite")) {
420 s_addr = strsep(&tok, ":");
423 unsigned addr = strtoul(s_addr, NULL, 16);
424 unsigned data_length = status - (data - packet);
426 // Length of decoded data cannot be more than
427 // encoded, as escapes are removed.
428 // Additional byte is reserved for alignment fix.
429 uint8_t *decoded = calloc(data_length + 1, 1);
430 unsigned dec_index = 0;
431 for(int i = 0; i < data_length; i++) {
432 if(data[i] == 0x7d) {
434 decoded[dec_index++] = data[i] ^ 0x20;
436 decoded[dec_index++] = data[i];
441 if(dec_index % 2 != 0)
445 printf("binary packet %d -> %d\n", data_length, dec_index);
448 if(flash_populate(addr, decoded, dec_index) < 0) {
449 reply = strdup("E00");
451 reply = strdup("OK");
453 } else if(!strcmp(cmdName, "FlashDone")) {
454 if(flash_go(sl) < 0) {
455 reply = strdup("E00");
457 reply = strdup("OK");
472 printf("Core running, waiting for interrupt (either in chip or GDB).\n");
475 int status = gdb_check_for_interrupt(client);
477 fprintf(stderr, "cannot check for int: %d\n", status);
482 stlink_force_debug(sl);
487 if(sl->core_stat == STLINK_CORE_HALTED) {
494 reply = strdup("S05"); // TRAP
500 reply = strdup("S05"); // TRAP
504 reply = strdup("S05"); // TRAP
508 stlink_read_all_regs(sl);
510 reply = calloc(8 * 16 + 1, 1);
511 for(int i = 0; i < 16; i++)
512 sprintf(&reply[i * 8], "%08x", htonl(sl->reg.r[i]));
517 unsigned id = strtoul(&packet[1], NULL, 16), reg = 0xDEADDEAD;
520 stlink_read_reg(sl, id);
521 reg = htonl(sl->reg.r[id]);
522 } else if(id == 0x19) {
523 stlink_read_reg(sl, 16);
524 reg = htonl(sl->reg.xpsr);
526 reply = strdup("E00");
529 reply = calloc(8 + 1, 1);
530 sprintf(reply, "%08x", reg);
536 char* s_reg = &packet[1];
537 char* s_value = strstr(&packet[1], "=") + 1;
539 unsigned reg = strtoul(s_reg, NULL, 16);
540 unsigned value = strtoul(s_value, NULL, 16);
543 stlink_write_reg(sl, ntohl(value), reg);
544 } else if(reg == 0x19) {
545 stlink_write_reg(sl, ntohl(value), 16);
547 reply = strdup("E00");
551 reply = strdup("OK");
558 for(int i = 0; i < 16; i++) {
560 strncpy(str, &packet[1 + i * 8], 8);
561 uint32_t reg = strtoul(str, NULL, 16);
562 stlink_write_reg(sl, ntohl(reg), i);
565 reply = strdup("OK");
569 char* s_start = &packet[1];
570 char* s_count = strstr(&packet[1], ",") + 1;
572 stm32_addr_t start = strtoul(s_start, NULL, 16);
573 unsigned count = strtoul(s_count, NULL, 16);
575 unsigned adj_start = start % 4;
577 stlink_read_mem32(sl, start - adj_start, (count % 4 == 0) ?
578 count : count + 4 - (count % 4));
580 reply = calloc(count * 2 + 1, 1);
581 for(int i = 0; i < count; i++) {
582 reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
583 reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
590 char* s_start = &packet[1];
591 char* s_count = strstr(&packet[1], ",") + 1;
592 char* hexdata = strstr(packet, ":") + 1;
594 stm32_addr_t start = strtoul(s_start, NULL, 16);
595 unsigned count = strtoul(s_count, NULL, 16);
597 for(int i = 0; i < count; i ++) {
598 char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
599 uint8_t byte = strtoul(hex, NULL, 16);
603 if((count % 4) == 0 && (start % 4) == 0) {
604 stlink_write_mem32(sl, start, count);
606 stlink_write_mem8(sl, start, count);
609 reply = strdup("OK");
615 if(packet[1] == '1') {
616 stm32_addr_t addr = strtoul(&packet[3], NULL, 16);
617 if(update_code_breakpoint(sl, addr, 1) < 0) {
618 reply = strdup("E00");
620 reply = strdup("OK");
630 if(packet[1] == '1') {
631 stm32_addr_t addr = strtoul(&packet[3], NULL, 16);
632 update_code_breakpoint(sl, addr, 0);
634 reply = strdup("OK");
643 // After this function will be entered afterwards, the
644 // chip will be reset anyway. So this is a no-op.
656 printf("send: %s\n", reply);
659 int result = gdb_send_packet(client, reply);
661 fprintf(stderr, "cannot send: %d\n", result);