4 Copyright 2008, 2009 Michel Pollet <buserror@gmail.com>
6 This file is part of simavr.
8 simavr is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 simavr is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with simavr. If not, see <http://www.gnu.org/licenses/>.
22 #include <netinet/in.h>
23 #include <netinet/tcp.h>
24 #include <arpa/inet.h>
25 #include <sys/socket.h>
36 #include "avr_eeprom.h"
41 #define WATCH_LIMIT (32)
44 uint32_t len; /**< How many points are taken (points[0] .. points[len - 1]). */
46 uint32_t addr; /**< Which address is watched. */
47 uint32_t size; /**< How large is the watched segment. */
48 uint32_t kind; /**< Bitmask of enum avr_gdb_watch_type values. */
49 } points[WATCH_LIMIT];
50 } avr_gdb_watchpoints_t;
52 typedef struct avr_gdb_t {
54 int listen; // listen socket
55 int s; // current gdb connection
57 avr_gdb_watchpoints_t breakpoints;
58 avr_gdb_watchpoints_t watchpoints;
63 * Returns the index of the watchpoint if found, -1 otherwise.
65 static int gdb_watch_find(const avr_gdb_watchpoints_t * w, uint32_t addr)
67 for (int i = 0; i < w->len; i++) {
68 if (w->points[i].addr > addr) {
70 } else if (w->points[i].addr == addr) {
79 * Contrary to gdb_watch_find, this actually checks the address against
80 * a watched memory _range_.
82 static int gdb_watch_find_range(const avr_gdb_watchpoints_t * w, uint32_t addr)
84 for (int i = 0; i < w->len; i++) {
85 if (w->points[i].addr > addr) {
87 } else if (w->points[i].addr <= addr && addr < w->points[i].addr + w->points[i].size) {
96 * Returns -1 on error, 0 otherwise.
98 static int gdb_watch_add_or_update(avr_gdb_watchpoints_t * w, enum avr_gdb_watch_type kind, uint32_t addr,
101 /* If the watchpoint exists, update it. */
102 int i = gdb_watch_find(w, addr);
104 w->points[i].size = size;
105 w->points[i].kind |= kind;
109 /* Otherwise add it. */
110 if (w->len == WATCH_LIMIT) {
114 /* Find the insertion point. */
115 for (i = 0; i < w->len; i++) {
116 if (w->points[i].addr > addr) {
123 /* Make space for new element. */
124 for (int j = i + 1; j < w->len; j++) {
125 w->points[j] = w->points[j - 1];
129 w->points[i].kind = kind;
130 w->points[i].addr = addr;
131 w->points[i].size = size;
137 * Returns -1 on error or if the specified point does not exist, 0 otherwise.
139 static int gdb_watch_rm(avr_gdb_watchpoints_t * w, enum avr_gdb_watch_type kind, uint32_t addr)
141 int i = gdb_watch_find(w, addr);
146 w->points[i].kind &= ~kind;
147 if (w->points[i].kind) {
151 for (i = i + 1; i < w->len; i++) {
152 w->points[i - 1] = w->points[i];
160 static void gdb_watch_clear(avr_gdb_watchpoints_t * w)
165 static void gdb_send_reply(avr_gdb_t * g, char * cmd)
168 uint8_t * dst = reply;
175 sprintf((char*)dst, "#%02x", check);
176 DBG(printf("%s '%s'\n", __FUNCTION__, reply);)
177 send(g->s, reply, dst - reply + 3, 0);
180 static void gdb_send_quick_status(avr_gdb_t * g, uint8_t signal)
184 sprintf(cmd, "T%02x20:%02x;21:%02x%02x;22:%02x%02x%02x00;",
185 signal ? signal : 5, g->avr->data[R_SREG],
186 g->avr->data[R_SPL], g->avr->data[R_SPH],
187 g->avr->pc & 0xff, (g->avr->pc>>8)&0xff, (g->avr->pc>>16)&0xff);
188 gdb_send_reply(g, cmd);
191 static int gdb_change_breakpoint(avr_gdb_watchpoints_t * w, int set, enum avr_gdb_watch_type kind,
192 uint32_t addr, uint32_t size)
194 DBG(printf("set %d kind %d addr %08x len %d\n", set, kind, addr, len);)
197 return gdb_watch_add_or_update(w, kind, addr, size);
199 return gdb_watch_rm(w, kind, addr);
205 static int gdb_write_register(avr_gdb_t * g, int regi, uint8_t * src)
209 g->avr->data[regi] = *src;
212 g->avr->data[R_SREG] = *src;
215 g->avr->data[R_SPL] = src[0];
216 g->avr->data[R_SPH] = src[1];
219 g->avr->pc = src[0] | (src[1] << 8) | (src[2] << 16) | (src[3] << 24);
225 static int gdb_read_register(avr_gdb_t * g, int regi, char * rep)
229 sprintf(rep, "%02x", g->avr->data[regi]);
232 sprintf(rep, "%02x", g->avr->data[R_SREG]);
235 sprintf(rep, "%02x%02x", g->avr->data[R_SPL], g->avr->data[R_SPH]);
238 sprintf(rep, "%02x%02x%02x00",
239 g->avr->pc & 0xff, (g->avr->pc>>8)&0xff, (g->avr->pc>>16)&0xff);
245 static void gdb_handle_command(avr_gdb_t * g, char * cmd)
247 avr_t * avr = g->avr;
249 uint8_t command = *cmd++;
252 gdb_send_quick_status(g, 0);
254 case 'G': { // set all general purpose registers
255 // get their binary form
256 read_hex_string(cmd, (uint8_t*)rep, strlen(cmd));
257 uint8_t *src = (uint8_t*)rep;
258 for (int i = 0; i < 35; i++)
259 src += gdb_write_register(g, i, src);
260 gdb_send_reply(g, "OK");
262 case 'g': { // read all general purpose registers
264 for (int i = 0; i < 35; i++)
265 dst += gdb_read_register(g, i, dst);
266 gdb_send_reply(g, rep);
268 case 'p': { // read register
269 unsigned int regi = 0;
270 sscanf(cmd, "%x", ®i);
271 gdb_read_register(g, regi, rep);
272 gdb_send_reply(g, rep);
274 case 'P': { // write register
275 unsigned int regi = 0;
276 char * val = strchr(cmd, '=');
280 sscanf(cmd, "%x", ®i);
281 read_hex_string(val, (uint8_t*)rep, strlen(val));
282 gdb_write_register(g, regi, (uint8_t*)rep);
283 gdb_send_reply(g, "OK");
285 case 'm': { // read memory
286 avr_flashaddr_t addr;
288 sscanf(cmd, "%x,%x", &addr, &len);
289 uint8_t * src = NULL;
290 if (addr < avr->flashend) {
291 src = avr->flash + addr;
292 } else if (addr >= 0x800000 && (addr - 0x800000) <= avr->ramend) {
293 src = avr->data + addr - 0x800000;
294 } else if (addr >= 0x810000 && (addr - 0x810000) <= avr->e2end) {
295 avr_eeprom_desc_t ee = {.offset = (addr - 0x810000)};
296 avr_ioctl(avr, AVR_IOCTL_EEPROM_GET, &ee);
300 gdb_send_reply(g, "E01");
303 } else if (addr >= 0x800000 && (addr - 0x800000) == avr->ramend+1 && len == 2) {
304 // Allow GDB to read a value just after end of stack.
305 // This is necessary to make instruction stepping work when stack is empty
306 printf("GDB read just past end of stack %08x, %08x; returning zero\n", addr, len);
307 gdb_send_reply(g, "0000");
310 printf("read memory error %08x, %08x (ramend %04x)\n", addr, len, avr->ramend+1);
311 gdb_send_reply(g, "E01");
316 sprintf(dst, "%02x", *src++);
320 gdb_send_reply(g, rep);
322 case 'M': { // write memory
324 sscanf(cmd, "%x,%x", &addr, &len);
325 char * start = strchr(cmd, ':');
327 gdb_send_reply(g, "E01");
331 read_hex_string(start + 1, avr->flash + addr, strlen(start+1));
332 gdb_send_reply(g, "OK");
333 } else if (addr >= 0x800000 && (addr - 0x800000) <= avr->ramend) {
334 read_hex_string(start + 1, avr->data + addr - 0x800000, strlen(start+1));
335 gdb_send_reply(g, "OK");
336 } else if (addr >= 0x810000 && (addr - 0x810000) <= avr->e2end) {
337 read_hex_string(start + 1, (uint8_t*)rep, strlen(start+1));
338 avr_eeprom_desc_t ee = {.offset = (addr - 0x810000), .size = len, .ee = (uint8_t*)rep };
339 avr_ioctl(avr, AVR_IOCTL_EEPROM_SET, &ee);
340 gdb_send_reply(g, "OK");
342 printf("write memory error %08x, %08x\n", addr, len);
343 gdb_send_reply(g, "E01");
346 case 'c': { // continue
347 avr->state = cpu_Running;
350 avr->state = cpu_Step;
352 case 'r': { // deprecated, suggested for AVRStudio compatibility
353 avr->state = cpu_StepDone;
356 case 'Z': // set clear break/watchpoint
358 uint32_t kind, addr, len;
359 int set = (command == 'Z');
360 sscanf(cmd, "%d,%x,%x", &kind, &addr, &len);
361 // printf("breakpoint %d, %08x, %08x\n", kind, addr, len);
363 case 0: // software breakpoint
364 case 1: // hardware breakpoint
365 if (addr > avr->flashend ||
366 gdb_change_breakpoint(&g->breakpoints, set, 1 << kind, addr, len) == -1) {
367 gdb_send_reply(g, "E01");
371 gdb_send_reply(g, "OK");
373 case 2: // write watchpoint
374 case 3: // read watchpoint
375 case 4: // access watchpoint
376 /* Mask out the offset applied to SRAM addresses. */
378 if (addr > avr->ramend ||
379 gdb_change_breakpoint(&g->watchpoints, set, 1 << kind, addr, len) == -1) {
380 gdb_send_reply(g, "E01");
384 gdb_send_reply(g, "OK");
387 gdb_send_reply(g, "");
392 gdb_send_reply(g, "");
397 static int gdb_network_handler(avr_gdb_t * g, uint32_t dosleep)
404 FD_SET(g->s, &read_set);
407 FD_SET(g->listen, &read_set);
410 struct timeval timo = { 0, dosleep }; // short, but not too short interval
411 int ret = select(max, &read_set, NULL, NULL, &timo);
416 if (FD_ISSET(g->listen, &read_set)) {
417 g->s = accept(g->listen, NULL, NULL);
420 perror("gdb_network_handler accept");
425 setsockopt (g->s, IPPROTO_TCP, TCP_NODELAY, &i, sizeof (i));
426 g->avr->state = cpu_Stopped;
427 printf("%s connection opened\n", __FUNCTION__);
430 if (g->s != -1 && FD_ISSET(g->s, &read_set)) {
431 uint8_t buffer[1024];
433 ssize_t r = recv(g->s, buffer, sizeof(buffer)-1, 0);
436 printf("%s connection closed\n", __FUNCTION__);
438 gdb_watch_clear(&g->breakpoints);
439 gdb_watch_clear(&g->watchpoints);
440 g->avr->state = cpu_Running; // resume
445 perror("gdb_network_handler recv");
450 // printf("%s: received %d bytes\n'%s'\n", __FUNCTION__, r, buffer);
451 // hdump("gdb", buffer, r);
453 uint8_t * src = buffer;
454 while (*src == '+' || *src == '-')
456 // control C -- lets send the guy a nice status packet
459 g->avr->state = cpu_StepDone;
460 printf("GDB hit control-c\n");
464 uint8_t * end = buffer + r - 1;
465 while (end > src && *end != '#')
469 DBG(printf("GDB command = '%s'\n", src);)
471 send(g->s, "+", 1, 0);
473 gdb_handle_command(g, (char*)src);
480 * If an applicable watchpoint exists for addr, stop the cpu and send a status report.
481 * type is one of AVR_GDB_WATCH_READ, AVR_GDB_WATCH_WRITE depending on the type of access.
483 void avr_gdb_handle_watchpoints(avr_t * avr, uint16_t addr, enum avr_gdb_watch_type type)
485 avr_gdb_t *g = avr->gdb;
487 int i = gdb_watch_find_range(&g->watchpoints, addr);
492 int kind = g->watchpoints.points[i].kind;
494 /* Send gdb reply (see GDB user manual appendix E.3). */
496 sprintf(cmd, "T%02x20:%02x;21:%02x%02x;22:%02x%02x%02x00;%s:%06x;",
497 5, g->avr->data[R_SREG],
498 g->avr->data[R_SPL], g->avr->data[R_SPH],
499 g->avr->pc & 0xff, (g->avr->pc>>8)&0xff, (g->avr->pc>>16)&0xff,
500 kind & AVR_GDB_WATCH_ACCESS ? "awatch" : kind & AVR_GDB_WATCH_WRITE ? "watch" : "rwatch",
502 gdb_send_reply(g, cmd);
504 avr->state = cpu_Stopped;
508 int avr_gdb_processor(avr_t * avr, int sleep)
510 if (!avr || !avr->gdb)
512 avr_gdb_t * g = avr->gdb;
514 if (avr->state == cpu_Running && gdb_watch_find(&g->breakpoints, avr->pc) != -1) {
515 DBG(printf("avr_gdb_processor hit breakpoint at %08x\n", avr->pc);)
516 gdb_send_quick_status(g, 0);
517 avr->state = cpu_Stopped;
518 } else if (avr->state == cpu_StepDone) {
519 gdb_send_quick_status(g, 0);
520 avr->state = cpu_Stopped;
522 // this also sleeps for a bit
523 return gdb_network_handler(g, sleep);
527 int avr_gdb_init(avr_t * avr)
529 avr_gdb_t * g = malloc(sizeof(avr_gdb_t));
530 memset(g, 0, sizeof(avr_gdb_t));
534 if ((g->listen = socket(PF_INET, SOCK_STREAM, 0)) < 0) {
535 fprintf(stderr, "Can't create socket: %s", strerror(errno));
540 setsockopt(g->listen, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
542 struct sockaddr_in address = { 0 };
543 address.sin_family = AF_INET;
544 address.sin_port = htons (avr->gdb_port);
546 if (bind(g->listen, (struct sockaddr *) &address, sizeof(address))) {
547 fprintf(stderr, "Can not bind socket: %s", strerror(errno));
550 if (listen(g->listen, 1)) {
554 printf("avr_gdb_init listening on port %d\n", avr->gdb_port);
558 // change default run behaviour to use the slightly slower versions
559 avr->run = avr_callback_run_gdb;
560 avr->sleep = avr_callback_sleep_gdb;