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 #define FLASH_BASE 0x08000000
21 #define FLASH_PAGE (sl->flash_pgsz)
22 #define FLASH_PAGE_MASK (~((1 << 10) - 1))
23 #define FLASH_SIZE (FLASH_PAGE * 128)
25 static const char hex[] = "0123456789abcdef";
27 static const char* current_memory_map = NULL;
32 uint32_t max_flash_size, flash_pagesize;
34 uint32_t bootrom_base, bootrom_size;
36 { 0x412, "Low-density device",
37 0x8000, 0x400, 0x2800, 0x1ffff000, 0x800 },
38 { 0x410, "Medium-density device",
39 0x20000, 0x400, 0x5000, 0x1ffff000, 0x800 },
40 { 0x414, "High-density device",
41 0x80000, 0x800, 0x10000, 0x1ffff000, 0x800 },
42 { 0x418, "Connectivity line device",
43 0x40000, 0x800, 0x10000, 0x1fffb000, 0x4800 },
44 { 0x420, "Medium-density value line device",
45 0x20000, 0x400, 0x2000, 0x1ffff000, 0x800 },
46 { 0x428, "High-density value line device",
47 0x80000, 0x800, 0x8000, 0x1ffff000, 0x800 },
48 { 0x430, "XL-density device",
49 0x100000, 0x800, 0x18000, 0x1fffe000, 0x1800 },
53 int serve(struct stlink* sl, int port);
54 char* make_memory_map(const struct chip_params *params, uint32_t flash_size);
56 int main(int argc, char** argv) {
58 struct stlink *sl = NULL;
63 fprintf(stderr, "Usage: %s <port> [/dev/sgX] \n", argv[0]);
68 sl = stlink_quirk_open(argv[2], 0);
69 if(sl == NULL) return 1;
73 case 2 : { // Search ST-LINK (from /dev/sg0 to /dev/sg99)
74 const int DevNumMax = 99;
75 int ExistDevCount = 0;
77 for(int DevNum = 0; DevNum <= DevNumMax; DevNum++)
80 char DevName[] = "/dev/sgX";
81 const int X_index = 7;
82 DevName[X_index] = DevNum + '0';
83 if ( !access(DevName, F_OK) ) {
84 sl = stlink_quirk_open(DevName, 0);
88 else if(DevNum < 100) {
89 char DevName[] = "/dev/sgXY";
90 const int X_index = 7;
91 const int Y_index = 8;
92 DevName[X_index] = DevNum/10 + '0';
93 DevName[Y_index] = DevNum%10 + '0';
94 if ( !access(DevName, F_OK) ) {
95 sl = stlink_quirk_open(DevName, 0);
103 fprintf(stdout, "\nNumber of /dev/sgX devices found: %i \n",
105 fprintf(stderr, "ST-LINK not found\n");
112 if(stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
113 stlink_enter_swd_mode(sl);
117 stlink_read_mem32(sl, 0xE0042000, 4);
118 chip_id = sl->q_buf[0] | (sl->q_buf[1] << 8) | (sl->q_buf[2] << 16) |
119 (sl->q_buf[3] << 24);
121 printf("Chip ID is %08x.\n", chip_id);
123 const struct chip_params* params = NULL;
125 for(int i = 0; i < sizeof(devices) / sizeof(devices[0]); i++) {
126 if(devices[i].chip_id == (chip_id & 0xFFF)) {
127 params = &devices[i];
133 fprintf(stderr, "Cannot recognize the connected device!\n");
137 printf("Device connected: %s\n", params->description);
138 printf("Device parameters: SRAM: 0x%x bytes, Flash: up to 0x%x bytes in pages of 0x%x bytes\n",
139 params->sram_size, params->max_flash_size, params->flash_pagesize);
141 FLASH_PAGE = params->flash_pagesize;
145 stlink_read_mem32(sl, 0x1FFFF7E0, 4);
146 flash_size = sl->q_buf[0] | (sl->q_buf[1] << 8);
148 printf("Flash size is %d KiB.\n", flash_size);
149 // memory map is in 1k blocks.
150 current_memory_map = make_memory_map(params, flash_size * 0x400);
152 int port = atoi(argv[1]);
154 while(serve(sl, port) == 0);
161 static const char* const memory_map_template =
162 "<?xml version=\"1.0\"?>"
163 "<!DOCTYPE memory-map PUBLIC \"+//IDN gnu.org//DTD GDB Memory Map V1.0//EN\""
164 " \"http://sourceware.org/gdb/gdb-memory-map.dtd\">"
166 " <memory type=\"rom\" start=\"0x00000000\" length=\"0x%x\"/>" // code = sram, bootrom or flash; flash is bigger
167 " <memory type=\"ram\" start=\"0x20000000\" length=\"0x%x\"/>" // sram 8k
168 " <memory type=\"flash\" start=\"0x08000000\" length=\"0x%x\">"
169 " <property name=\"blocksize\">0x%x</property>"
171 " <memory type=\"ram\" start=\"0x40000000\" length=\"0x1fffffff\"/>" // peripheral regs
172 " <memory type=\"ram\" start=\"0xe0000000\" length=\"0x1fffffff\"/>" // cortex regs
173 " <memory type=\"rom\" start=\"0x%08x\" length=\"0x%x\"/>" // bootrom
174 " <memory type=\"rom\" start=\"0x1ffff800\" length=\"0x8\"/>" // option byte area
177 char* make_memory_map(const struct chip_params *params, uint32_t flash_size) {
178 /* This will be freed in serve() */
179 char* map = malloc(4096);
182 snprintf(map, 4096, memory_map_template,
185 flash_size, params->flash_pagesize,
186 params->bootrom_base, params->bootrom_size);
193 * DWT_COMP0 0xE0001020
194 * DWT_MASK0 0xE0001024
195 * DWT_FUNCTION0 0xE0001028
196 * DWT_COMP1 0xE0001030
197 * DWT_MASK1 0xE0001034
198 * DWT_FUNCTION1 0xE0001038
199 * DWT_COMP2 0xE0001040
200 * DWT_MASK2 0xE0001044
201 * DWT_FUNCTION2 0xE0001048
202 * DWT_COMP3 0xE0001050
203 * DWT_MASK3 0xE0001054
204 * DWT_FUNCTION3 0xE0001058
207 #define DATA_WATCH_NUM 4
209 enum watchfun { WATCHDISABLED = 0, WATCHREAD = 5, WATCHWRITE = 6, WATCHACCESS = 7 };
211 struct code_hw_watchpoint {
217 struct code_hw_watchpoint data_watches[DATA_WATCH_NUM];
219 static void init_data_watchpoints(struct stlink *sl) {
223 printf("init watchpoints\n");
226 // set trcena in debug command to turn on dwt unit
227 stlink_read_mem32(sl, 0xE000EDFC, 4);
229 stlink_write_mem32(sl, 0xE000EDFC, 4);
231 // make sure all watchpoints are cleared
232 memset(sl->q_buf, 0, 4);
233 for(int i = 0; i < DATA_WATCH_NUM; i++) {
234 data_watches[i].fun = WATCHDISABLED;
235 stlink_write_mem32(sl, 0xe0001028 + i * 16, 4);
239 static int add_data_watchpoint(struct stlink* sl, enum watchfun wf, stm32_addr_t addr, unsigned int len)
245 // find a free watchpoint
255 if((mask != -1) && (mask < 16)) {
256 for(i = 0; i < DATA_WATCH_NUM; i++) {
257 // is this an empty slot ?
258 if(data_watches[i].fun == WATCHDISABLED) {
260 printf("insert watchpoint %d addr %x wf %u mask %u len %d\n", i, addr, wf, mask, len);
263 data_watches[i].fun = wf;
264 data_watches[i].addr = addr;
265 data_watches[i].mask = mask;
267 // insert comparator address
268 sl->q_buf[0] = (addr & 0xff);
269 sl->q_buf[1] = ((addr >> 8) & 0xff);
270 sl->q_buf[2] = ((addr >> 16) & 0xff);
271 sl->q_buf[3] = ((addr >> 24) & 0xff);
273 stlink_write_mem32(sl, 0xE0001020 + i * 16, 4);
276 memset(sl->q_buf, 0, 4);
278 stlink_write_mem32(sl, 0xE0001024 + i * 16, 4);
281 memset(sl->q_buf, 0, 4);
283 stlink_write_mem32(sl, 0xE0001028 + i * 16, 4);
285 // just to make sure the matched bit is clear !
286 stlink_read_mem32(sl, 0xE0001028 + i * 16, 4);
293 printf("failure: add watchpoints addr %x wf %u len %u\n", addr, wf, len);
298 static int delete_data_watchpoint(struct stlink* sl, stm32_addr_t addr)
302 for(i = 0 ; i < DATA_WATCH_NUM; i++) {
303 if((data_watches[i].addr == addr) && (data_watches[i].fun != WATCHDISABLED)) {
305 printf("delete watchpoint %d addr %x\n", i, addr);
308 memset(sl->q_buf, 0, 4);
309 data_watches[i].fun = WATCHDISABLED;
310 stlink_write_mem32(sl, 0xe0001028 + i * 16, 4);
317 printf("failure: delete watchpoint addr %x\n", addr);
323 #define CODE_BREAK_NUM 6
324 #define CODE_BREAK_LOW 0x01
325 #define CODE_BREAK_HIGH 0x02
327 struct code_hw_breakpoint {
332 struct code_hw_breakpoint code_breaks[CODE_BREAK_NUM];
334 static void init_code_breakpoints(struct stlink* sl) {
335 memset(sl->q_buf, 0, 4);
336 sl->q_buf[0] = 0x03; // KEY | ENABLE
337 stlink_write_mem32(sl, 0xe0002000, 4);
339 memset(sl->q_buf, 0, 4);
340 for(int i = 0; i < CODE_BREAK_NUM; i++) {
341 code_breaks[i].type = 0;
342 stlink_write_mem32(sl, 0xe0002008 + i * 4, 4);
346 static int update_code_breakpoint(struct stlink* sl, stm32_addr_t addr, int set) {
347 stm32_addr_t fpb_addr = addr & ~0x3;
348 int type = addr & 0x2 ? CODE_BREAK_HIGH : CODE_BREAK_LOW;
351 fprintf(stderr, "update_code_breakpoint: unaligned address %08x\n", addr);
356 for(int i = 0; i < CODE_BREAK_NUM; i++) {
357 if(fpb_addr == code_breaks[i].addr ||
358 (set && code_breaks[i].type == 0)) {
365 if(set) return -1; // Free slot not found
366 else return 0; // Breakpoint is already removed
369 struct code_hw_breakpoint* brk = &code_breaks[id];
371 brk->addr = fpb_addr;
373 if(set) brk->type |= type;
374 else brk->type &= ~type;
376 memset(sl->q_buf, 0, 4);
380 printf("clearing hw break %d\n", id);
383 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
385 sl->q_buf[0] = ( brk->addr & 0xff) | 1;
386 sl->q_buf[1] = ((brk->addr >> 8) & 0xff);
387 sl->q_buf[2] = ((brk->addr >> 16) & 0xff);
388 sl->q_buf[3] = ((brk->addr >> 24) & 0xff) | (brk->type << 6);
391 printf("setting hw break %d at %08x (%d)\n",
392 id, brk->addr, brk->type);
393 printf("reg %02x %02x %02x %02x\n",
394 sl->q_buf[3], sl->q_buf[2], sl->q_buf[1], sl->q_buf[0]);
397 stlink_write_mem32(sl, 0xe0002008 + id * 4, 4);
409 struct flash_block* next;
412 static struct flash_block* flash_root;
414 static int flash_add_block(stm32_addr_t addr, unsigned length,
416 if(addr < FLASH_BASE || addr + length > FLASH_BASE + FLASH_SIZE) {
417 fprintf(stderr, "flash_add_block: incorrect bounds\n");
421 if(addr % FLASH_PAGE != 0 || length % FLASH_PAGE != 0) {
422 fprintf(stderr, "flash_add_block: unaligned block\n");
426 struct flash_block* new = malloc(sizeof(struct flash_block));
427 new->next = flash_root;
430 new->length = length;
431 new->data = calloc(length, 1);
438 static int flash_populate(stm32_addr_t addr, uint8_t* data, unsigned length) {
439 int fit_blocks = 0, fit_length = 0;
441 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
442 /* Block: ------X------Y--------
446 * Block intersects with data, if:
450 unsigned X = fb->addr, Y = fb->addr + fb->length;
451 unsigned a = addr, b = addr + length;
453 // from start of the block
454 unsigned start = (a > X ? a : X) - X;
455 unsigned end = (b > Y ? Y : b) - X;
457 memcpy(fb->data + start, data, end - start);
460 fit_length += end - start;
464 if(fit_blocks == 0) {
465 fprintf(stderr, "Unfit data block %08x -> %04x\n", addr, length);
469 if(fit_length != length) {
470 fprintf(stderr, "warning: data block %08x -> %04x truncated to %04x\n",
471 addr, length, fit_length);
472 fprintf(stderr, "(this is not an error, just a GDB glitch)\n");
478 static int flash_go(struct stlink* sl) {
481 // Some kinds of clock settings do not allow writing to flash.
484 for(struct flash_block* fb = flash_root; fb; fb = fb->next) {
486 printf("flash_do: block %08x -> %04x\n", fb->addr, fb->length);
489 unsigned length = fb->length;
490 for(stm32_addr_t page = fb->addr; page < fb->addr + fb->length; page += FLASH_PAGE) {
492 printf("flash_do: page %08x\n", page);
495 stlink_erase_flash_page(sl, page);
497 if(stlink_write_flash(sl, page, fb->data + (page - fb->addr),
498 length > FLASH_PAGE ? FLASH_PAGE : length) < 0)
509 for(struct flash_block* fb = flash_root, *next; fb; fb = next) {
520 int serve(struct stlink* sl, int port) {
521 int sock = socket(AF_INET, SOCK_STREAM, 0);
527 unsigned int val = 1;
528 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
530 struct sockaddr_in serv_addr = {0};
531 serv_addr.sin_family = AF_INET;
532 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
533 serv_addr.sin_port = htons(port);
535 if(bind(sock, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0) {
540 if(listen(sock, 5) < 0) {
545 stlink_force_debug(sl);
547 init_code_breakpoints(sl);
548 init_data_watchpoints(sl);
550 printf("Listening at *:%d...\n", port);
552 int client = accept(sock, NULL, NULL);
560 printf("GDB connected.\n");
563 * To allow resetting the chip from GDB it is required to
564 * emulate attaching and detaching to target.
566 unsigned int attached = 1;
571 int status = gdb_recv_packet(client, &packet);
573 fprintf(stderr, "cannot recv: %d\n", status);
578 printf("recv: %s\n", packet);
585 if(packet[1] == 'P' || packet[1] == 'C' || packet[1] == 'L') {
590 char *separator = strstr(packet, ":"), *params = "";
591 if(separator == NULL) {
592 separator = packet + strlen(packet);
594 params = separator + 1;
597 unsigned queryNameLength = (separator - &packet[1]);
598 char* queryName = calloc(queryNameLength + 1, 1);
599 strncpy(queryName, &packet[1], queryNameLength);
602 printf("query: %s;%s\n", queryName, params);
605 if(!strcmp(queryName, "Supported")) {
606 reply = strdup("PacketSize=3fff;qXfer:memory-map:read+");
607 } else if(!strcmp(queryName, "Xfer")) {
608 char *type, *op, *annex, *s_addr, *s_length;
611 type = strsep(&tok, ":");
612 op = strsep(&tok, ":");
613 annex = strsep(&tok, ":");
614 s_addr = strsep(&tok, ",");
617 unsigned addr = strtoul(s_addr, NULL, 16),
618 length = strtoul(s_length, NULL, 16);
621 printf("Xfer: type:%s;op:%s;annex:%s;addr:%d;length:%d\n",
622 type, op, annex, addr, length);
625 const char* data = NULL;
627 if(!strcmp(type, "memory-map") && !strcmp(op, "read"))
628 data = current_memory_map;
631 unsigned data_length = strlen(data);
632 if(addr + length > data_length)
633 length = data_length - addr;
638 reply = calloc(length + 2, 1);
640 strncpy(&reply[1], data, length);
655 char *cmdName = strtok_r(packet, ":;", ¶ms);
657 cmdName++; // vCommand -> Command
659 if(!strcmp(cmdName, "FlashErase")) {
660 char *s_addr, *s_length;
663 s_addr = strsep(&tok, ",");
666 unsigned addr = strtoul(s_addr, NULL, 16),
667 length = strtoul(s_length, NULL, 16);
670 printf("FlashErase: addr:%08x,len:%04x\n",
674 if(flash_add_block(addr, length, sl) < 0) {
675 reply = strdup("E00");
677 reply = strdup("OK");
679 } else if(!strcmp(cmdName, "FlashWrite")) {
683 s_addr = strsep(&tok, ":");
686 unsigned addr = strtoul(s_addr, NULL, 16);
687 unsigned data_length = status - (data - packet);
689 // Length of decoded data cannot be more than
690 // encoded, as escapes are removed.
691 // Additional byte is reserved for alignment fix.
692 uint8_t *decoded = calloc(data_length + 1, 1);
693 unsigned dec_index = 0;
694 for(int i = 0; i < data_length; i++) {
695 if(data[i] == 0x7d) {
697 decoded[dec_index++] = data[i] ^ 0x20;
699 decoded[dec_index++] = data[i];
704 if(dec_index % 2 != 0)
708 printf("binary packet %d -> %d\n", data_length, dec_index);
711 if(flash_populate(addr, decoded, dec_index) < 0) {
712 reply = strdup("E00");
714 reply = strdup("OK");
716 } else if(!strcmp(cmdName, "FlashDone")) {
717 if(flash_go(sl) < 0) {
718 reply = strdup("E00");
720 reply = strdup("OK");
722 } else if(!strcmp(cmdName, "Kill")) {
725 reply = strdup("OK");
738 int status = gdb_check_for_interrupt(client);
740 fprintf(stderr, "cannot check for int: %d\n", status);
745 stlink_force_debug(sl);
750 if(sl->core_stat == STLINK_CORE_HALTED) {
757 reply = strdup("S05"); // TRAP
763 reply = strdup("S05"); // TRAP
768 reply = strdup("S05"); // TRAP
770 /* Stub shall reply OK if not attached. */
771 reply = strdup("OK");
776 stlink_read_all_regs(sl);
778 reply = calloc(8 * 16 + 1, 1);
779 for(int i = 0; i < 16; i++)
780 sprintf(&reply[i * 8], "%08x", htonl(sl->reg.r[i]));
785 unsigned id = strtoul(&packet[1], NULL, 16), reg = 0xDEADDEAD;
788 stlink_read_reg(sl, id);
789 reg = htonl(sl->reg.r[id]);
790 } else if(id == 0x19) {
791 stlink_read_reg(sl, 16);
792 reg = htonl(sl->reg.xpsr);
794 reply = strdup("E00");
797 reply = calloc(8 + 1, 1);
798 sprintf(reply, "%08x", reg);
804 char* s_reg = &packet[1];
805 char* s_value = strstr(&packet[1], "=") + 1;
807 unsigned reg = strtoul(s_reg, NULL, 16);
808 unsigned value = strtoul(s_value, NULL, 16);
811 stlink_write_reg(sl, ntohl(value), reg);
812 } else if(reg == 0x19) {
813 stlink_write_reg(sl, ntohl(value), 16);
815 reply = strdup("E00");
819 reply = strdup("OK");
826 for(int i = 0; i < 16; i++) {
828 strncpy(str, &packet[1 + i * 8], 8);
829 uint32_t reg = strtoul(str, NULL, 16);
830 stlink_write_reg(sl, ntohl(reg), i);
833 reply = strdup("OK");
837 char* s_start = &packet[1];
838 char* s_count = strstr(&packet[1], ",") + 1;
840 stm32_addr_t start = strtoul(s_start, NULL, 16);
841 unsigned count = strtoul(s_count, NULL, 16);
843 unsigned adj_start = start % 4;
845 stlink_read_mem32(sl, start - adj_start, (count % 4 == 0) ?
846 count : count + 4 - (count % 4));
848 reply = calloc(count * 2 + 1, 1);
849 for(int i = 0; i < count; i++) {
850 reply[i * 2 + 0] = hex[sl->q_buf[i + adj_start] >> 4];
851 reply[i * 2 + 1] = hex[sl->q_buf[i + adj_start] & 0xf];
858 char* s_start = &packet[1];
859 char* s_count = strstr(&packet[1], ",") + 1;
860 char* hexdata = strstr(packet, ":") + 1;
862 stm32_addr_t start = strtoul(s_start, NULL, 16);
863 unsigned count = strtoul(s_count, NULL, 16);
865 for(int i = 0; i < count; i ++) {
866 char hex[3] = { hexdata[i*2], hexdata[i*2+1], 0 };
867 uint8_t byte = strtoul(hex, NULL, 16);
871 if((count % 4) == 0 && (start % 4) == 0) {
872 stlink_write_mem32(sl, start, count);
874 stlink_write_mem8(sl, start, count);
877 reply = strdup("OK");
884 stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
885 stm32_addr_t len = strtoul(&endptr[1], NULL, 16);
889 if(update_code_breakpoint(sl, addr, 1) < 0) {
890 reply = strdup("E00");
892 reply = strdup("OK");
896 case '2': // insert write watchpoint
897 case '3': // insert read watchpoint
898 case '4': // insert access watchpoint
901 if(packet[1] == '2') {
903 } else if(packet[1] == '3') {
907 if(add_data_watchpoint(sl, wf, addr, len) < 0) {
908 reply = strdup("E00");
910 reply = strdup("OK");
923 stm32_addr_t addr = strtoul(&packet[3], &endptr, 16);
924 stm32_addr_t len = strtoul(&endptr[1], NULL, 16);
927 case '1': // remove breakpoint
928 update_code_breakpoint(sl, addr, 0);
929 reply = strdup("OK");
932 case '2' : // remove write watchpoint
933 case '3' : // remove read watchpoint
934 case '4' : // remove access watchpoint
935 if(delete_data_watchpoint(sl, addr) < 0) {
936 reply = strdup("E00");
938 reply = strdup("OK");
950 * Enter extended mode which allows restarting.
951 * We do support that always.
954 reply = strdup("OK");
960 /* Reset the core. */
963 init_code_breakpoints(sl);
964 init_data_watchpoints(sl);
968 reply = strdup("OK");
979 printf("send: %s\n", reply);
982 int result = gdb_send_packet(client, reply);
984 fprintf(stderr, "cannot send: %d\n", result);