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_size, flash_pagesize;
29 uint32_t bootrom_base, bootrom_size;
31 { 0x412, "Low-density device",
32 0x8000, 0x400, 0x2800, 0x1ffff000, 0x800 },
33 { 0x410, "Medium-density device",
34 0x20000, 0x400, 0x5000, 0x1ffff000, 0x800 },
35 { 0x414, "High-density device",
36 0x80000, 0x800, 0x10000, 0x1ffff000, 0x800 },
37 { 0x418, "Connectivity line device",
38 0x40000, 0x800, 0x10000, 0x1fffb000, 0x4800 },
39 { 0x420, "Medium-density value line device",
40 0x20000, 0x400, 0x2000, 0x1ffff000, 0x800 },
41 { 0x428, "High-density value line device",
42 0x80000, 0x800, 0x8000, 0x1ffff000, 0x800 },
43 { 0x430, "XL-density device",
44 0x100000, 0x800, 0x18000, 0x1fffe000, 0x1800 },
48 int serve(struct stlink* sl, int port);
49 char* make_memory_map(const struct chip_params *params);
51 int main(int argc, char** argv) {
53 fprintf(stderr, "Usage: %s <port> /dev/sgX\n", argv[0]);
57 struct stlink *sl = stlink_quirk_open(argv[2], 0);
61 if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
62 stlink_enter_swd_mode(sl);
66 stlink_read_mem32(sl, 0xE0042000, 4);
67 chip_id = sl->q_buf[0] | (sl->q_buf[1] << 8) | (sl->q_buf[2] << 16) |
70 printf("Chip ID is %08x.\n", chip_id);
72 const struct chip_params* params = NULL;
74 for(int i = 0; i < sizeof(devices) / sizeof(devices[0]); i++) {
75 if(devices[i].chip_id == chip_id) {
82 fprintf(stderr, "Cannot recognize the connected device!\n");
86 printf("Device connected: %s\n", params->description);
87 printf("Device parameters: SRAM: 0x%x bytes, Flash: 0x%x bytes in pages of %x bytes\n",
88 params->sram_size, params->flash_size, params->flash_pagesize);
90 current_memory_map = make_memory_map(params);
92 int port = atoi(argv[1]);
94 while(serve(sl, port) == 0);
101 static const char* const memory_map_template =
102 "<?xml version=\"1.0\"?>"
103 "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
104 " \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
106 " <memory type=\"rom\" start=\"0x00000000\" length=\"0x%x\"/>" // code = sram, bootrom or flash; flash is bigger
107 " <memory type=\"ram\" start=\"0x20000000\" length=\"0x%x\"/>" // sram 8k
108 " <memory type=\"flash\" start=\"0x08000000\" length=\"0x%x\">"
109 " <property name=\"blocksize\">0x%x</property>"
111 " <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>" // peripheral regs
112 " <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>" // cortex regs
113 " <memory type=\"rom\" start=\"0x%08x\" length=\"0x%x\"/>" // bootrom
114 " <memory type=\"rom\" start=\"0x1ffff800\" length=\"0x8\"/>" // option byte area
117 char* make_memory_map(const struct chip_params *params) {
118 /* This will be freed in serve() */
119 char* map = malloc(4096);
122 snprintf(map, 4096, memory_map_template,
125 params->flash_size, params->flash_pagesize,
126 params->bootrom_base, params->bootrom_size);
131 #define CODE_BREAK_NUM 6
133 #define CODE_BREAK_LOW 0x01
134 #define CODE_BREAK_HIGH 0x02
136 struct code_hw_breakpoint {
141 struct code_hw_breakpoint code_breaks[CODE_BREAK_NUM];
143 static void init_code_breakpoints(struct stlink* sl) {
144 memset(sl->q_buf, 0, 4);
145 sl->q_buf[0] = 0x03; // KEY | ENABLE
146 stlink_write_mem32(sl, 0xe0002000, 4);
148 memset(sl->q_buf, 0, 4);
149 for(int i = 0; i < CODE_BREAK_NUM; i++) {
150 code_breaks[i].type = 0;
151 stlink_write_mem32(sl, 0xe0002008 + i * 4, 4);
155 static int update_code_breakpoint(struct stlink* sl, stm32_addr_t addr, int set) {
156 stm32_addr_t fpb_addr = addr & ~0x3;
157 int type = addr & 0x2 ? CODE_BREAK_HIGH : CODE_BREAK_LOW;
160 fprintf(stderr, "update_code_breakpoint: unaligned address %08x\n", addr);
165 for(int i = 0; i < CODE_BREAK_NUM; i++) {
166 if(fpb_addr == code_breaks[i].addr ||
167 (set && code_breaks[i].type == 0)) {
174 if(set) return -1; // Free slot not found
175 else return 0; // Breakpoint is already removed
178 struct code_hw_breakpoint* brk = &code_breaks[id];
180 brk->addr = fpb_addr;
182 if(set) brk->type |= type;
183 else brk->type &= ~type;
185 memset(sl->q_buf, 0, 4);
189 printf("clearing hw break %d\n", id);
192 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
194 sl->q_buf[0] = ( brk->addr & 0xff) | 1;
195 sl->q_buf[1] = ((brk->addr >> 8) & 0xff);
196 sl->q_buf[2] = ((brk->addr >> 16) & 0xff);
197 sl->q_buf[3] = ((brk->addr >> 24) & 0xff) | (brk->type << 6);
200 printf("setting hw break %d at %08x (%d)\n",
201 id, brk->addr, brk->type);
202 printf("reg %02x %02x %02x %02x\n",
203 sl->q_buf[3], sl->q_buf[2], sl->q_buf[1], sl->q_buf[0]);
206 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
212 #define FLASH_BASE 0x08000000
213 #define FLASH_PAGE 0x400
214 #define FLASH_PAGE_MASK (~((1 << 10) - 1))
215 #define FLASH_SIZE (FLASH_PAGE * 128)
222 struct flash_block* next;
225 static struct flash_block* flash_root;
227 static int flash_add_block(stm32_addr_t addr, unsigned length) {
228 if(addr < FLASH_BASE || addr + length > FLASH_BASE + FLASH_SIZE) {
229 fprintf(stderr, "flash_add_block: incorrect bounds\n");
233 if(addr % FLASH_PAGE != 0 || length % FLASH_PAGE != 0) {
234 fprintf(stderr, "flash_add_block: unaligned block\n");
238 struct flash_block* new = malloc(sizeof(struct flash_block));
239 new->next = flash_root;
242 new->length = length;
243 new->data = calloc(length, 1);
250 static int flash_populate(stm32_addr_t addr, uint8_t* data, unsigned length) {
251 int fit_blocks = 0, fit_length = 0;
253 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
254 /* Block: ------X------Y--------
258 * Block intersects with data, if:
262 unsigned X = fb->addr, Y = fb->addr + fb->length;
263 unsigned a = addr, b = addr + length;
265 // from start of the block
266 unsigned start = (a > X ? a : X) - X;
267 unsigned end = (b > Y ? Y : b) - X;
269 memcpy(fb->data + start, data, end - start);
272 fit_length += end - start;
276 if(fit_blocks == 0) {
277 fprintf(stderr, "Unfit data block %08x -> %04x\n", addr, length);
281 if(fit_length != length) {
282 fprintf(stderr, "warning: data block %08x -> %04x truncated to %04x\n",
283 addr, length, fit_length);
284 fprintf(stderr, "(this is not an error, just a GDB glitch)\n");
290 static int flash_go(struct stlink* sl) {
293 // Some kinds of clock settings do not allow writing to flash.
296 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
298 printf("flash_do: block %08x -> %04x\n", fb->addr, fb->length);
301 unsigned length = fb->length;
302 for(stm32_addr_t page = fb->addr; page < fb->addr + fb->length; page += 0x400) {
304 printf("flash_do: page %08x\n", page);
307 stlink_erase_flash_page(sl, page);
309 if(stlink_write_flash(sl, page, fb->data + (page - fb->addr),
310 length > 0x400 ? 0x400 : length) < 0)
321 for(struct flash_block* fb = flash_root, *next; fb; fb = next) {
332 int serve(struct stlink* sl, int port) {
333 int sock = socket(AF_INET, SOCK_STREAM, 0);
339 unsigned int val = 1;
340 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
342 struct sockaddr_in serv_addr = {0};
343 serv_addr.sin_family = AF_INET;
344 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
345 serv_addr.sin_port = htons(port);
347 if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
352 if(listen(sock, 5) < 0) {
357 stlink_force_debug(sl);
359 init_code_breakpoints(sl);
361 printf("Listening at *:%d...\n", port);
363 int client = accept(sock, NULL, NULL);
371 printf("GDB connected.\n");
374 * To allow resetting the chip from GDB it is required to
375 * emulate attaching and detaching to target.
377 unsigned int attached = 1;
382 int status = gdb_recv_packet(client, &packet);
384 fprintf(stderr, "cannot recv: %d\n", status);
389 printf("recv: %s\n", packet);
396 if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
401 char *separator = strstr(packet, ":"), *params = "";
402 if(separator == NULL) {
403 separator = packet + strlen(packet);
405 params = separator + 1;
408 unsigned queryNameLength = (separator - &packet[1]);
409 char* queryName = calloc(queryNameLength + 1, 1);
410 strncpy(queryName, &packet[1], queryNameLength);
413 printf("query: %s;%s\n", queryName, params);
416 if(!strcmp(queryName, "Supported")) {
417 reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
418 } else if(!strcmp(queryName, "Xfer")) {
419 char *type, *op, *annex, *s_addr, *s_length;
422 type = strsep(&tok, ":");
423 op = strsep(&tok, ":");
424 annex = strsep(&tok, ":");
425 s_addr = strsep(&tok, ",");
428 unsigned addr = strtoul(s_addr, NULL, 16),
429 length = strtoul(s_length, NULL, 16);
432 printf("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
433 type, op, annex, addr, length);
436 const char* data = NULL;
438 if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
439 data = current_memory_map;
442 unsigned data_length = strlen(data);
443 if(addr + length > data_length)
444 length = data_length - addr;
449 reply = calloc(length + 2, 1);
451 strncpy(&reply[1], data, length);
466 char *cmdName = strtok_r(packet, ":;", ¶ms);
468 cmdName++; // vCommand -> Command
470 if(!strcmp(cmdName, "FlashErase")) {
471 char *s_addr, *s_length;
474 s_addr = strsep(&tok, ",");
477 unsigned addr = strtoul(s_addr, NULL, 16),
478 length = strtoul(s_length, NULL, 16);
481 printf("FlashErase: addr:%08x,len:%04x\n",
485 if(flash_add_block(addr, length) < 0) {
486 reply = strdup("E00");
488 reply = strdup("OK");
490 } else if(!strcmp(cmdName, "FlashWrite")) {
494 s_addr = strsep(&tok, ":");
497 unsigned addr = strtoul(s_addr, NULL, 16);
498 unsigned data_length = status - (data - packet);
500 // Length of decoded data cannot be more than
501 // encoded, as escapes are removed.
502 // Additional byte is reserved for alignment fix.
503 uint8_t *decoded = calloc(data_length + 1, 1);
504 unsigned dec_index = 0;
505 for(int i = 0; i < data_length; i++) {
506 if(data[i] == 0x7d) {
508 decoded[dec_index++] = data[i] ^ 0x20;
510 decoded[dec_index++] = data[i];
515 if(dec_index % 2 != 0)
519 printf("binary packet %d -> %d\n", data_length, dec_index);
522 if(flash_populate(addr, decoded, dec_index) < 0) {
523 reply = strdup("E00");
525 reply = strdup("OK");
527 } else if(!strcmp(cmdName, "FlashDone")) {
528 if(flash_go(sl) < 0) {
529 reply = strdup("E00");
531 reply = strdup("OK");
533 } else if(!strcmp(cmdName, "Kill")) {
536 reply = strdup("OK");
549 int status = gdb_check_for_interrupt(client);
551 fprintf(stderr, "cannot check for int: %d\n", status);
556 stlink_force_debug(sl);
561 if(sl->core_stat == STLINK_CORE_HALTED) {
568 reply = strdup("S05"); // TRAP
574 reply = strdup("S05"); // TRAP
579 reply = strdup("S05"); // TRAP
581 /* Stub shall reply OK if not attached. */
582 reply = strdup("OK");
587 stlink_read_all_regs(sl);
589 reply = calloc(8 * 16 + 1, 1);
590 for(int i = 0; i < 16; i++)
591 sprintf(&reply[i * 8], "%08x", htonl(sl->reg.r[i]));
596 unsigned id = strtoul(&packet[1], NULL, 16), reg = 0xDEADDEAD;
599 stlink_read_reg(sl, id);
600 reg = htonl(sl->reg.r[id]);
601 } else if(id == 0x19) {
602 stlink_read_reg(sl, 16);
603 reg = htonl(sl->reg.xpsr);
605 reply = strdup("E00");
608 reply = calloc(8 + 1, 1);
609 sprintf(reply, "%08x", reg);
615 char* s_reg = &packet[1];
616 char* s_value = strstr(&packet[1], "=") + 1;
618 unsigned reg = strtoul(s_reg, NULL, 16);
619 unsigned value = strtoul(s_value, NULL, 16);
622 stlink_write_reg(sl, ntohl(value), reg);
623 } else if(reg == 0x19) {
624 stlink_write_reg(sl, ntohl(value), 16);
626 reply = strdup("E00");
630 reply = strdup("OK");
637 for(int i = 0; i < 16; i++) {
639 strncpy(str, &packet[1 + i * 8], 8);
640 uint32_t reg = strtoul(str, NULL, 16);
641 stlink_write_reg(sl, ntohl(reg), i);
644 reply = strdup("OK");
648 char* s_start = &packet[1];
649 char* s_count = strstr(&packet[1], ",") + 1;
651 stm32_addr_t start = strtoul(s_start, NULL, 16);
652 unsigned count = strtoul(s_count, NULL, 16);
654 unsigned adj_start = start % 4;
656 stlink_read_mem32(sl, start - adj_start, (count % 4 == 0) ?
657 count : count + 4 - (count % 4));
659 reply = calloc(count * 2 + 1, 1);
660 for(int i = 0; i < count; i++) {
661 reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
662 reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
669 char* s_start = &packet[1];
670 char* s_count = strstr(&packet[1], ",") + 1;
671 char* hexdata = strstr(packet, ":") + 1;
673 stm32_addr_t start = strtoul(s_start, NULL, 16);
674 unsigned count = strtoul(s_count, NULL, 16);
676 for(int i = 0; i < count; i ++) {
677 char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
678 uint8_t byte = strtoul(hex, NULL, 16);
682 if((count % 4) == 0 && (start % 4) == 0) {
683 stlink_write_mem32(sl, start, count);
685 stlink_write_mem8(sl, start, count);
688 reply = strdup("OK");
694 if(packet[1] == '1') {
695 stm32_addr_t addr = strtoul(&packet[3], NULL, 16);
696 if(update_code_breakpoint(sl, addr, 1) < 0) {
697 reply = strdup("E00");
699 reply = strdup("OK");
709 if(packet[1] == '1') {
710 stm32_addr_t addr = strtoul(&packet[3], NULL, 16);
711 update_code_breakpoint(sl, addr, 0);
713 reply = strdup("OK");
723 * Enter extended mode which allows restarting.
724 * We do support that always.
727 reply = strdup("OK");
733 /* Reset the core. */
736 init_code_breakpoints(sl);
740 reply = strdup("OK");
751 printf("send: %s\n", reply);
754 int result = gdb_send_packet(client, reply);
756 fprintf(stderr, "cannot send: %d\n", result);