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 max_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, uint16_t flash_size);
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 & 0xFFF)) {
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: up to 0x%x bytes in pages of 0x%x bytes\n",
88 params->sram_size, params->max_flash_size, params->flash_pagesize);
92 stlink_read_mem32(sl, 0x1FFFF7E0, 4);
93 flash_size = sl->q_buf[0] | (sl->q_buf[1] << 8);
95 printf("Flash size is %d KiB.\n", flash_size);
97 current_memory_map = make_memory_map(params, flash_size * 0x400);
99 int port = atoi(argv[1]);
101 while(serve(sl, port) == 0);
108 static const char* const memory_map_template =
109 "<?xml version=\"1.0\"?>"
110 "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
111 " \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
113 " <memory type=\"rom\" start=\"0x00000000\" length=\"0x%x\"/>" // code = sram, bootrom or flash; flash is bigger
114 " <memory type=\"ram\" start=\"0x20000000\" length=\"0x%x\"/>" // sram 8k
115 " <memory type=\"flash\" start=\"0x08000000\" length=\"0x%x\">"
116 " <property name=\"blocksize\">0x%x</property>"
118 " <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>" // peripheral regs
119 " <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>" // cortex regs
120 " <memory type=\"rom\" start=\"0x%08x\" length=\"0x%x\"/>" // bootrom
121 " <memory type=\"rom\" start=\"0x1ffff800\" length=\"0x8\"/>" // option byte area
124 char* make_memory_map(const struct chip_params *params, uint16_t flash_size) {
125 /* This will be freed in serve() */
126 char* map = malloc(4096);
129 snprintf(map, 4096, memory_map_template,
132 flash_size, params->flash_pagesize,
133 params->bootrom_base, params->bootrom_size);
138 #define CODE_BREAK_NUM 6
140 #define CODE_BREAK_LOW 0x01
141 #define CODE_BREAK_HIGH 0x02
143 struct code_hw_breakpoint {
148 struct code_hw_breakpoint code_breaks[CODE_BREAK_NUM];
150 static void init_code_breakpoints(struct stlink* sl) {
151 memset(sl->q_buf, 0, 4);
152 sl->q_buf[0] = 0x03; // KEY | ENABLE
153 stlink_write_mem32(sl, 0xe0002000, 4);
155 memset(sl->q_buf, 0, 4);
156 for(int i = 0; i < CODE_BREAK_NUM; i++) {
157 code_breaks[i].type = 0;
158 stlink_write_mem32(sl, 0xe0002008 + i * 4, 4);
162 static int update_code_breakpoint(struct stlink* sl, stm32_addr_t addr, int set) {
163 stm32_addr_t fpb_addr = addr & ~0x3;
164 int type = addr & 0x2 ? CODE_BREAK_HIGH : CODE_BREAK_LOW;
167 fprintf(stderr, "update_code_breakpoint: unaligned address %08x\n", addr);
172 for(int i = 0; i < CODE_BREAK_NUM; i++) {
173 if(fpb_addr == code_breaks[i].addr ||
174 (set && code_breaks[i].type == 0)) {
181 if(set) return -1; // Free slot not found
182 else return 0; // Breakpoint is already removed
185 struct code_hw_breakpoint* brk = &code_breaks[id];
187 brk->addr = fpb_addr;
189 if(set) brk->type |= type;
190 else brk->type &= ~type;
192 memset(sl->q_buf, 0, 4);
196 printf("clearing hw break %d\n", id);
199 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
201 sl->q_buf[0] = ( brk->addr & 0xff) | 1;
202 sl->q_buf[1] = ((brk->addr >> 8) & 0xff);
203 sl->q_buf[2] = ((brk->addr >> 16) & 0xff);
204 sl->q_buf[3] = ((brk->addr >> 24) & 0xff) | (brk->type << 6);
207 printf("setting hw break %d at %08x (%d)\n",
208 id, brk->addr, brk->type);
209 printf("reg %02x %02x %02x %02x\n",
210 sl->q_buf[3], sl->q_buf[2], sl->q_buf[1], sl->q_buf[0]);
213 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
219 #define FLASH_BASE 0x08000000
220 #define FLASH_PAGE 0x400
221 #define FLASH_PAGE_MASK (~((1 << 10) - 1))
222 #define FLASH_SIZE (FLASH_PAGE * 128)
229 struct flash_block* next;
232 static struct flash_block* flash_root;
234 static int flash_add_block(stm32_addr_t addr, unsigned length) {
235 if(addr < FLASH_BASE || addr + length > FLASH_BASE + FLASH_SIZE) {
236 fprintf(stderr, "flash_add_block: incorrect bounds\n");
240 if(addr % FLASH_PAGE != 0 || length % FLASH_PAGE != 0) {
241 fprintf(stderr, "flash_add_block: unaligned block\n");
245 struct flash_block* new = malloc(sizeof(struct flash_block));
246 new->next = flash_root;
249 new->length = length;
250 new->data = calloc(length, 1);
257 static int flash_populate(stm32_addr_t addr, uint8_t* data, unsigned length) {
258 int fit_blocks = 0, fit_length = 0;
260 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
261 /* Block: ------X------Y--------
265 * Block intersects with data, if:
269 unsigned X = fb->addr, Y = fb->addr + fb->length;
270 unsigned a = addr, b = addr + length;
272 // from start of the block
273 unsigned start = (a > X ? a : X) - X;
274 unsigned end = (b > Y ? Y : b) - X;
276 memcpy(fb->data + start, data, end - start);
279 fit_length += end - start;
283 if(fit_blocks == 0) {
284 fprintf(stderr, "Unfit data block %08x -> %04x\n", addr, length);
288 if(fit_length != length) {
289 fprintf(stderr, "warning: data block %08x -> %04x truncated to %04x\n",
290 addr, length, fit_length);
291 fprintf(stderr, "(this is not an error, just a GDB glitch)\n");
297 static int flash_go(struct stlink* sl) {
300 // Some kinds of clock settings do not allow writing to flash.
303 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
305 printf("flash_do: block %08x -> %04x\n", fb->addr, fb->length);
308 unsigned length = fb->length;
309 for(stm32_addr_t page = fb->addr; page < fb->addr + fb->length; page += 0x400) {
311 printf("flash_do: page %08x\n", page);
314 stlink_erase_flash_page(sl, page);
316 if(stlink_write_flash(sl, page, fb->data + (page - fb->addr),
317 length > 0x400 ? 0x400 : length) < 0)
328 for(struct flash_block* fb = flash_root, *next; fb; fb = next) {
339 int serve(struct stlink* sl, int port) {
340 int sock = socket(AF_INET, SOCK_STREAM, 0);
346 unsigned int val = 1;
347 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
349 struct sockaddr_in serv_addr = {0};
350 serv_addr.sin_family = AF_INET;
351 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
352 serv_addr.sin_port = htons(port);
354 if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
359 if(listen(sock, 5) < 0) {
364 stlink_force_debug(sl);
366 init_code_breakpoints(sl);
368 printf("Listening at *:%d...\n", port);
370 int client = accept(sock, NULL, NULL);
378 printf("GDB connected.\n");
381 * To allow resetting the chip from GDB it is required to
382 * emulate attaching and detaching to target.
384 unsigned int attached = 1;
389 int status = gdb_recv_packet(client, &packet);
391 fprintf(stderr, "cannot recv: %d\n", status);
396 printf("recv: %s\n", packet);
403 if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
408 char *separator = strstr(packet, ":"), *params = "";
409 if(separator == NULL) {
410 separator = packet + strlen(packet);
412 params = separator + 1;
415 unsigned queryNameLength = (separator - &packet[1]);
416 char* queryName = calloc(queryNameLength + 1, 1);
417 strncpy(queryName, &packet[1], queryNameLength);
420 printf("query: %s;%s\n", queryName, params);
423 if(!strcmp(queryName, "Supported")) {
424 reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
425 } else if(!strcmp(queryName, "Xfer")) {
426 char *type, *op, *annex, *s_addr, *s_length;
429 type = strsep(&tok, ":");
430 op = strsep(&tok, ":");
431 annex = strsep(&tok, ":");
432 s_addr = strsep(&tok, ",");
435 unsigned addr = strtoul(s_addr, NULL, 16),
436 length = strtoul(s_length, NULL, 16);
439 printf("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
440 type, op, annex, addr, length);
443 const char* data = NULL;
445 if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
446 data = current_memory_map;
449 unsigned data_length = strlen(data);
450 if(addr + length > data_length)
451 length = data_length - addr;
456 reply = calloc(length + 2, 1);
458 strncpy(&reply[1], data, length);
473 char *cmdName = strtok_r(packet, ":;", ¶ms);
475 cmdName++; // vCommand -> Command
477 if(!strcmp(cmdName, "FlashErase")) {
478 char *s_addr, *s_length;
481 s_addr = strsep(&tok, ",");
484 unsigned addr = strtoul(s_addr, NULL, 16),
485 length = strtoul(s_length, NULL, 16);
488 printf("FlashErase: addr:%08x,len:%04x\n",
492 if(flash_add_block(addr, length) < 0) {
493 reply = strdup("E00");
495 reply = strdup("OK");
497 } else if(!strcmp(cmdName, "FlashWrite")) {
501 s_addr = strsep(&tok, ":");
504 unsigned addr = strtoul(s_addr, NULL, 16);
505 unsigned data_length = status - (data - packet);
507 // Length of decoded data cannot be more than
508 // encoded, as escapes are removed.
509 // Additional byte is reserved for alignment fix.
510 uint8_t *decoded = calloc(data_length + 1, 1);
511 unsigned dec_index = 0;
512 for(int i = 0; i < data_length; i++) {
513 if(data[i] == 0x7d) {
515 decoded[dec_index++] = data[i] ^ 0x20;
517 decoded[dec_index++] = data[i];
522 if(dec_index % 2 != 0)
526 printf("binary packet %d -> %d\n", data_length, dec_index);
529 if(flash_populate(addr, decoded, dec_index) < 0) {
530 reply = strdup("E00");
532 reply = strdup("OK");
534 } else if(!strcmp(cmdName, "FlashDone")) {
535 if(flash_go(sl) < 0) {
536 reply = strdup("E00");
538 reply = strdup("OK");
540 } else if(!strcmp(cmdName, "Kill")) {
543 reply = strdup("OK");
556 int status = gdb_check_for_interrupt(client);
558 fprintf(stderr, "cannot check for int: %d\n", status);
563 stlink_force_debug(sl);
568 if(sl->core_stat == STLINK_CORE_HALTED) {
575 reply = strdup("S05"); // TRAP
581 reply = strdup("S05"); // TRAP
586 reply = strdup("S05"); // TRAP
588 /* Stub shall reply OK if not attached. */
589 reply = strdup("OK");
594 stlink_read_all_regs(sl);
596 reply = calloc(8 * 16 + 1, 1);
597 for(int i = 0; i < 16; i++)
598 sprintf(&reply[i * 8], "%08x", htonl(sl->reg.r[i]));
603 unsigned id = strtoul(&packet[1], NULL, 16), reg = 0xDEADDEAD;
606 stlink_read_reg(sl, id);
607 reg = htonl(sl->reg.r[id]);
608 } else if(id == 0x19) {
609 stlink_read_reg(sl, 16);
610 reg = htonl(sl->reg.xpsr);
612 reply = strdup("E00");
615 reply = calloc(8 + 1, 1);
616 sprintf(reply, "%08x", reg);
622 char* s_reg = &packet[1];
623 char* s_value = strstr(&packet[1], "=") + 1;
625 unsigned reg = strtoul(s_reg, NULL, 16);
626 unsigned value = strtoul(s_value, NULL, 16);
629 stlink_write_reg(sl, ntohl(value), reg);
630 } else if(reg == 0x19) {
631 stlink_write_reg(sl, ntohl(value), 16);
633 reply = strdup("E00");
637 reply = strdup("OK");
644 for(int i = 0; i < 16; i++) {
646 strncpy(str, &packet[1 + i * 8], 8);
647 uint32_t reg = strtoul(str, NULL, 16);
648 stlink_write_reg(sl, ntohl(reg), i);
651 reply = strdup("OK");
655 char* s_start = &packet[1];
656 char* s_count = strstr(&packet[1], ",") + 1;
658 stm32_addr_t start = strtoul(s_start, NULL, 16);
659 unsigned count = strtoul(s_count, NULL, 16);
661 unsigned adj_start = start % 4;
663 stlink_read_mem32(sl, start - adj_start, (count % 4 == 0) ?
664 count : count + 4 - (count % 4));
666 reply = calloc(count * 2 + 1, 1);
667 for(int i = 0; i < count; i++) {
668 reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
669 reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
676 char* s_start = &packet[1];
677 char* s_count = strstr(&packet[1], ",") + 1;
678 char* hexdata = strstr(packet, ":") + 1;
680 stm32_addr_t start = strtoul(s_start, NULL, 16);
681 unsigned count = strtoul(s_count, NULL, 16);
683 for(int i = 0; i < count; i ++) {
684 char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
685 uint8_t byte = strtoul(hex, NULL, 16);
689 if((count % 4) == 0 && (start % 4) == 0) {
690 stlink_write_mem32(sl, start, count);
692 stlink_write_mem8(sl, start, count);
695 reply = strdup("OK");
701 if(packet[1] == '1') {
702 stm32_addr_t addr = strtoul(&packet[3], NULL, 16);
703 if(update_code_breakpoint(sl, addr, 1) < 0) {
704 reply = strdup("E00");
706 reply = strdup("OK");
716 if(packet[1] == '1') {
717 stm32_addr_t addr = strtoul(&packet[3], NULL, 16);
718 update_code_breakpoint(sl, addr, 0);
720 reply = strdup("OK");
730 * Enter extended mode which allows restarting.
731 * We do support that always.
734 reply = strdup("OK");
740 /* Reset the core. */
743 init_code_breakpoints(sl);
747 reply = strdup("OK");
758 printf("send: %s\n", reply);
761 int result = gdb_send_packet(client, reply);
763 fprintf(stderr, "cannot send: %d\n", result);