1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2009 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
30 #include <target/breakpoints.h>
31 #include <target/target_request.h>
32 #include <target/register.h>
34 #include <flash/nor/core.h>
35 #include "gdb_server.h"
36 #include <target/image.h>
37 #include <jtag/jtag.h>
42 * GDB server implementation.
44 * This implements the GDB Remote Serial Protocol, over TCP connections,
45 * giving GDB access to the JTAG or other hardware debugging facilities
46 * found in most modern embedded processors.
49 /* private connection data for GDB */
52 char buffer[GDB_BUFFER_SIZE];
56 enum target_state frontend_state;
57 struct image *vflash_image;
61 bool sync; /* set flag to true if you want the next stepi to return immediately.
62 allowing GDB to pick up a fresh set of register values from the target
63 without modifying the target state. */
69 #define _DEBUG_GDB_IO_
72 static struct gdb_connection *current_gdb_connection;
74 static int gdb_breakpoint_override;
75 static enum breakpoint_type gdb_breakpoint_override_type;
77 static int gdb_error(struct connection *connection, int retval);
78 static unsigned short gdb_port = 3333;
79 static unsigned short gdb_port_next = 0;
80 static const char DIGITS[16] = "0123456789abcdef";
82 static void gdb_log_callback(void *priv, const char *file, unsigned line,
83 const char *function, const char *string);
85 /* number of gdb connections, mainly to suppress gdb related debugging spam
86 * in helper/log.c when no gdb connections are actually active */
87 int gdb_actual_connections;
89 /* set if we are sending a memory map to gdb
90 * via qXfer:memory-map:read packet */
91 /* enabled by default*/
92 static int gdb_use_memory_map = 1;
93 /* enabled by default*/
94 static int gdb_flash_program = 1;
96 /* if set, data aborts cause an error to be reported in memory read packets
97 * see the code in gdb_read_memory_packet() for further explanations.
98 * Disabled by default.
100 static int gdb_report_data_abort;
102 static int gdb_last_signal(struct target *target)
104 switch (target->debug_reason)
106 case DBG_REASON_DBGRQ:
107 return 0x2; /* SIGINT */
108 case DBG_REASON_BREAKPOINT:
109 case DBG_REASON_WATCHPOINT:
110 case DBG_REASON_WPTANDBKPT:
111 return 0x05; /* SIGTRAP */
112 case DBG_REASON_SINGLESTEP:
113 return 0x05; /* SIGTRAP */
114 case DBG_REASON_NOTHALTED:
115 return 0x0; /* no signal... shouldn't happen */
117 LOG_USER("undefined debug reason %d - target needs reset", target->debug_reason);
122 static int check_pending(struct connection *connection,
123 int timeout_s, int *got_data)
125 /* a non-blocking socket will block if there is 0 bytes available on the socket,
126 * but return with as many bytes as are available immediately
130 struct gdb_connection *gdb_con = connection->priv;
132 if (got_data == NULL)
136 if (gdb_con->buf_cnt > 0)
143 FD_SET(connection->fd, &read_fds);
145 tv.tv_sec = timeout_s;
147 if (socket_select(connection->fd + 1, &read_fds, NULL, NULL, &tv) == 0)
149 /* This can typically be because a "monitor" command took too long
150 * before printing any progress messages
154 return ERROR_GDB_TIMEOUT;
160 *got_data = FD_ISSET(connection->fd, &read_fds) != 0;
164 static int gdb_get_char_inner(struct connection *connection, int* next_char)
166 struct gdb_connection *gdb_con = connection->priv;
167 int retval = ERROR_OK;
171 if (connection->service->type == CONNECTION_PIPE)
173 gdb_con->buf_cnt = read(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE);
177 retval = check_pending(connection, 1, NULL);
178 if (retval != ERROR_OK)
180 gdb_con->buf_cnt = read_socket(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE);
183 if (gdb_con->buf_cnt > 0)
187 if (gdb_con->buf_cnt == 0)
190 return ERROR_SERVER_REMOTE_CLOSED;
194 errno = WSAGetLastError();
201 case WSAECONNABORTED:
203 return ERROR_SERVER_REMOTE_CLOSED;
206 return ERROR_SERVER_REMOTE_CLOSED;
208 LOG_ERROR("read: %d", errno);
219 return ERROR_SERVER_REMOTE_CLOSED;
222 return ERROR_SERVER_REMOTE_CLOSED;
224 LOG_ERROR("read: %s", strerror(errno));
226 return ERROR_SERVER_REMOTE_CLOSED;
231 #ifdef _DEBUG_GDB_IO_
232 debug_buffer = malloc(gdb_con->buf_cnt + 1);
233 memcpy(debug_buffer, gdb_con->buffer, gdb_con->buf_cnt);
234 debug_buffer[gdb_con->buf_cnt] = 0;
235 LOG_DEBUG("received '%s'", debug_buffer);
239 gdb_con->buf_p = gdb_con->buffer;
241 *next_char = *(gdb_con->buf_p++);
242 if (gdb_con->buf_cnt > 0)
243 connection->input_pending = 1;
245 connection->input_pending = 0;
246 #ifdef _DEBUG_GDB_IO_
247 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
254 * The cool thing about this fn is that it allows buf_p and buf_cnt to be
255 * held in registers in the inner loop.
257 * For small caches and embedded systems this is important!
259 static inline int gdb_get_char_fast(struct connection *connection, int* next_char, char **buf_p, int *buf_cnt)
261 int retval = ERROR_OK;
263 if ((*buf_cnt)-- > 0)
265 *next_char = **buf_p;
268 connection->input_pending = 1;
270 connection->input_pending = 0;
272 #ifdef _DEBUG_GDB_IO_
273 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
279 struct gdb_connection *gdb_con = connection->priv;
280 gdb_con->buf_p = *buf_p;
281 gdb_con->buf_cnt = *buf_cnt;
282 retval = gdb_get_char_inner(connection, next_char);
283 *buf_p = gdb_con->buf_p;
284 *buf_cnt = gdb_con->buf_cnt;
290 static int gdb_get_char(struct connection *connection, int* next_char)
292 struct gdb_connection *gdb_con = connection->priv;
293 return gdb_get_char_fast(connection, next_char, &gdb_con->buf_p, &gdb_con->buf_cnt);
297 static int gdb_putback_char(struct connection *connection, int last_char)
299 struct gdb_connection *gdb_con = connection->priv;
301 if (gdb_con->buf_p > gdb_con->buffer)
303 *(--gdb_con->buf_p) = last_char;
308 LOG_ERROR("BUG: couldn't put character back");
314 /* The only way we can detect that the socket is closed is the first time
315 * we write to it, we will fail. Subsequent write operations will
316 * succeed. Shudder! */
317 static int gdb_write(struct connection *connection, void *data, int len)
319 struct gdb_connection *gdb_con = connection->priv;
321 return ERROR_SERVER_REMOTE_CLOSED;
323 if (connection->service->type == CONNECTION_PIPE)
325 /* write to stdout */
326 if (write(STDOUT_FILENO, data, len) == len)
333 if (write_socket(connection->fd, data, len) == len)
339 return ERROR_SERVER_REMOTE_CLOSED;
342 static int gdb_put_packet_inner(struct connection *connection,
343 char *buffer, int len)
346 unsigned char my_checksum = 0;
347 #ifdef _DEBUG_GDB_IO_
352 struct gdb_connection *gdb_con = connection->priv;
354 for (i = 0; i < len; i++)
355 my_checksum += buffer[i];
357 #ifdef _DEBUG_GDB_IO_
359 * At this point we should have nothing in the input queue from GDB,
360 * however sometimes '-' is sent even though we've already received
361 * an ACK (+) for everything we've sent off.
366 retval = check_pending(connection, 0, &gotdata);
367 if (retval != ERROR_OK)
371 if ((retval = gdb_get_char(connection, &reply)) != ERROR_OK)
374 /* fix a problem with some IAR tools */
375 gdb_putback_char(connection, reply);
376 LOG_DEBUG("Unexpected start of new packet");
380 LOG_WARNING("Discard unexpected char %c", reply);
386 #ifdef _DEBUG_GDB_IO_
387 debug_buffer = malloc(len + 1);
388 memcpy(debug_buffer, buffer, len);
389 debug_buffer[len] = 0;
390 LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer, my_checksum);
394 char local_buffer[1024];
395 local_buffer[0] = '$';
396 if ((size_t)len + 4 <= sizeof(local_buffer))
398 /* performance gain on smaller packets by only a single call to gdb_write() */
399 memcpy(local_buffer + 1, buffer, len++);
400 local_buffer[len++] = '#';
401 local_buffer[len++] = DIGITS[(my_checksum >> 4) & 0xf];
402 local_buffer[len++] = DIGITS[my_checksum & 0xf];
403 if ((retval = gdb_write(connection, local_buffer, len)) != ERROR_OK)
410 /* larger packets are transmitted directly from caller supplied buffer
411 by several calls to gdb_write() to avoid dynamic allocation */
412 local_buffer[1] = '#';
413 local_buffer[2] = DIGITS[(my_checksum >> 4) & 0xf];
414 local_buffer[3] = DIGITS[my_checksum & 0xf];
415 if ((retval = gdb_write(connection, local_buffer, 1)) != ERROR_OK)
419 if ((retval = gdb_write(connection, buffer, len)) != ERROR_OK)
423 if ((retval = gdb_write(connection, local_buffer + 1, 3)) != ERROR_OK)
429 if (gdb_con->noack_mode)
432 if ((retval = gdb_get_char(connection, &reply)) != ERROR_OK)
437 else if (reply == '-')
439 /* Stop sending output packets for now */
440 log_remove_callback(gdb_log_callback, connection);
441 LOG_WARNING("negative reply, retrying");
443 else if (reply == 0x3)
446 if ((retval = gdb_get_char(connection, &reply)) != ERROR_OK)
450 else if (reply == '-')
452 /* Stop sending output packets for now */
453 log_remove_callback(gdb_log_callback, connection);
454 LOG_WARNING("negative reply, retrying");
456 else if (reply == '$') {
457 LOG_ERROR("GDB missing ack(1) - assumed good");
458 gdb_putback_char(connection, reply);
462 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply);
464 return ERROR_SERVER_REMOTE_CLOSED;
467 else if (reply == '$') {
468 LOG_ERROR("GDB missing ack(2) - assumed good");
469 gdb_putback_char(connection, reply);
474 LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection", reply);
476 return ERROR_SERVER_REMOTE_CLOSED;
480 return ERROR_SERVER_REMOTE_CLOSED;
485 static int gdb_put_packet(struct connection *connection, char *buffer, int len)
487 struct gdb_connection *gdb_con = connection->priv;
489 int retval = gdb_put_packet_inner(connection, buffer, len);
492 /* we sent some data, reset timer for keep alive messages */
498 static __inline__ int fetch_packet(struct connection *connection, int *checksum_ok, int noack, int *len, char *buffer)
500 unsigned char my_checksum = 0;
503 int retval = ERROR_OK;
505 struct gdb_connection *gdb_con = connection->priv;
510 /* move this over into local variables to use registers and give the
511 * more freedom to optimize */
512 char *buf_p = gdb_con->buf_p;
513 int buf_cnt = gdb_con->buf_cnt;
517 /* The common case is that we have an entire packet with no escape chars.
518 * We need to leave at least 2 bytes in the buffer to have
519 * gdb_get_char() update various bits and bobs correctly.
521 if ((buf_cnt > 2) && ((buf_cnt + count) < *len))
523 /* The compiler will struggle a bit with constant propagation and
524 * aliasing, so we help it by showing that these values do not
525 * change inside the loop
529 int run = buf_cnt - 2;
536 if (character == '#')
538 /* Danger! character can be '#' when esc is
539 * used so we need an explicit boolean for done here.
545 if (character == '}')
547 /* data transmitted in binary mode (X packet)
548 * uses 0x7d as escape character */
549 my_checksum += character & 0xff;
552 my_checksum += character & 0xff;
553 buffer[count++] = (character ^ 0x20) & 0xff;
557 my_checksum += character & 0xff;
558 buffer[count++] = character & 0xff;
568 LOG_ERROR("packet buffer too small");
569 retval = ERROR_GDB_BUFFER_TOO_SMALL;
573 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
574 if (retval != ERROR_OK)
577 if (character == '#')
580 if (character == '}')
582 /* data transmitted in binary mode (X packet)
583 * uses 0x7d as escape character */
584 my_checksum += character & 0xff;
586 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
587 if (retval != ERROR_OK)
590 my_checksum += character & 0xff;
591 buffer[count++] = (character ^ 0x20) & 0xff;
595 my_checksum += character & 0xff;
596 buffer[count++] = character & 0xff;
600 gdb_con->buf_p = buf_p;
601 gdb_con->buf_cnt = buf_cnt;
603 if (retval != ERROR_OK)
608 if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
610 checksum[0] = character;
611 if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
613 checksum[1] = character;
618 *checksum_ok = (my_checksum == strtoul(checksum, NULL, 16));
624 static int gdb_get_packet_inner(struct connection *connection,
625 char *buffer, int *len)
629 struct gdb_connection *gdb_con = connection->priv;
635 if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
638 #ifdef _DEBUG_GDB_IO_
639 LOG_DEBUG("character: '%c'", character);
647 /* gdb sends a dummy ack '+' at every remote connect - see remote_start_remote (remote.c)
648 * in case anyone tries to debug why they receive this warning every time */
649 LOG_WARNING("acknowledgment received, but no packet pending");
652 LOG_WARNING("negative acknowledgment, but no packet pending");
659 LOG_WARNING("ignoring character 0x%x", character);
662 } while (character != '$');
667 /* explicit code expansion here to get faster inlined code in -O3 by not
668 * calculating checksum
670 if (gdb_con->noack_mode)
672 if ((retval = fetch_packet(connection, &checksum_ok, 1, len, buffer)) != ERROR_OK)
676 if ((retval = fetch_packet(connection, &checksum_ok, 0, len, buffer)) != ERROR_OK)
680 if (gdb_con->noack_mode)
682 /* checksum is not checked in noack mode */
687 if ((retval = gdb_write(connection, "+", 1)) != ERROR_OK)
695 return ERROR_SERVER_REMOTE_CLOSED;
700 static int gdb_get_packet(struct connection *connection, char *buffer, int *len)
702 struct gdb_connection *gdb_con = connection->priv;
704 int retval = gdb_get_packet_inner(connection, buffer, len);
709 static int gdb_output_con(struct connection *connection, const char* line)
714 bin_size = strlen(line);
716 hex_buffer = malloc(bin_size*2 + 2);
717 if (hex_buffer == NULL)
718 return ERROR_GDB_BUFFER_TOO_SMALL;
721 for (i = 0; i < bin_size; i++)
722 snprintf(hex_buffer + 1 + i*2, 3, "%2.2x", line[i]);
723 hex_buffer[bin_size*2 + 1] = 0;
725 int retval = gdb_put_packet(connection, hex_buffer, bin_size*2 + 1);
731 static int gdb_output(struct command_context *context, const char* line)
733 /* this will be dumped to the log and also sent as an O packet if possible */
734 LOG_USER_N("%s", line);
739 static void gdb_frontend_halted(struct target *target, struct connection *connection)
741 struct gdb_connection *gdb_connection = connection->priv;
743 /* In the GDB protocol when we are stepping or continuing execution,
744 * we have a lingering reply. Upon receiving a halted event
745 * when we have that lingering packet, we reply to the original
746 * step or continue packet.
748 * Executing monitor commands can bring the target in and
749 * out of the running state so we'll see lots of TARGET_EVENT_XXX
750 * that are to be ignored.
752 if (gdb_connection->frontend_state == TARGET_RUNNING)
757 /* stop forwarding log packets! */
758 log_remove_callback(gdb_log_callback, connection);
760 if (gdb_connection->ctrl_c)
763 gdb_connection->ctrl_c = 0;
767 signal = gdb_last_signal(target);
770 snprintf(sig_reply, 4, "T%2.2x", signal);
771 gdb_put_packet(connection, sig_reply, 3);
772 gdb_connection->frontend_state = TARGET_HALTED;
776 static int gdb_target_callback_event_handler(struct target *target,
777 enum target_event event, void *priv)
780 struct connection *connection = priv;
782 target_handle_event(target, event);
785 case TARGET_EVENT_GDB_HALT:
786 gdb_frontend_halted(target, connection);
788 case TARGET_EVENT_HALTED:
789 target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
791 case TARGET_EVENT_GDB_FLASH_ERASE_START:
792 target_handle_event(target, TARGET_EVENT_OLD_gdb_program_config);
793 if ((retval = jtag_execute_queue()) != ERROR_OK)
805 static int gdb_new_connection(struct connection *connection)
807 struct gdb_connection *gdb_connection = malloc(sizeof(struct gdb_connection));
808 struct gdb_service *gdb_service = connection->service->priv;
812 connection->priv = gdb_connection;
814 /* initialize gdb connection information */
815 gdb_connection->buf_p = gdb_connection->buffer;
816 gdb_connection->buf_cnt = 0;
817 gdb_connection->ctrl_c = 0;
818 gdb_connection->frontend_state = TARGET_HALTED;
819 gdb_connection->vflash_image = NULL;
820 gdb_connection->closed = 0;
821 gdb_connection->busy = 0;
822 gdb_connection->noack_mode = 0;
823 gdb_connection->sync = true;
825 /* send ACK to GDB for debug request */
826 gdb_write(connection, "+", 1);
828 /* output goes through gdb connection */
829 command_set_output_handler(connection->cmd_ctx, gdb_output, connection);
831 /* we must remove all breakpoints registered to the target as a previous
832 * GDB session could leave dangling breakpoints if e.g. communication
835 breakpoint_clear_target(gdb_service->target);
836 watchpoint_clear_target(gdb_service->target);
838 /* register callback to be informed about target events */
839 target_register_event_callback(gdb_target_callback_event_handler, connection);
841 /* remove the initial ACK from the incoming buffer */
842 if ((retval = gdb_get_char(connection, &initial_ack)) != ERROR_OK)
845 /* FIX!!!??? would we actually ever receive a + here???
848 if (initial_ack != '+')
849 gdb_putback_char(connection, initial_ack);
850 target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_ATTACH);
852 gdb_actual_connections++;
853 LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s",
854 gdb_actual_connections,
855 target_name(gdb_service->target),
856 target_state_name(gdb_service->target));
861 static int gdb_connection_closed(struct connection *connection)
863 struct gdb_service *gdb_service = connection->service->priv;
864 struct gdb_connection *gdb_connection = connection->priv;
866 /* we're done forwarding messages. Tear down callback before
867 * cleaning up connection.
869 log_remove_callback(gdb_log_callback, connection);
871 gdb_actual_connections--;
872 LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
873 target_name(gdb_service->target),
874 target_state_name(gdb_service->target),
875 gdb_actual_connections);
877 /* see if an image built with vFlash commands is left */
878 if (gdb_connection->vflash_image)
880 image_close(gdb_connection->vflash_image);
881 free(gdb_connection->vflash_image);
882 gdb_connection->vflash_image = NULL;
885 /* if this connection registered a debug-message receiver delete it */
886 delete_debug_msg_receiver(connection->cmd_ctx, gdb_service->target);
888 if (connection->priv)
890 free(connection->priv);
891 connection->priv = NULL;
895 LOG_ERROR("BUG: connection->priv == NULL");
899 target_unregister_event_callback(gdb_target_callback_event_handler, connection);
901 target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_END);
903 target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH);
908 static void gdb_send_error(struct connection *connection, uint8_t the_error)
911 snprintf(err, 4, "E%2.2X", the_error);
912 gdb_put_packet(connection, err, 3);
915 static int gdb_last_signal_packet(struct connection *connection,
916 struct target *target, char* packet, int packet_size)
921 signal = gdb_last_signal(target);
923 snprintf(sig_reply, 4, "S%2.2x", signal);
924 gdb_put_packet(connection, sig_reply, 3);
929 static int gdb_reg_pos(struct target *target, int pos, int len)
931 if (target->endianness == TARGET_LITTLE_ENDIAN)
934 return len - 1 - pos;
937 /* Convert register to string of bytes. NB! The # of bits in the
938 * register might be non-divisible by 8(a byte), in which
939 * case an entire byte is shown.
941 * NB! the format on the wire is the target endianness
943 * The format of reg->value is little endian
946 static void gdb_str_to_target(struct target *target,
947 char *tstr, struct reg *reg)
954 buf_len = DIV_ROUND_UP(reg->size, 8);
956 for (i = 0; i < buf_len; i++)
958 int j = gdb_reg_pos(target, i, buf_len);
959 tstr[i*2] = DIGITS[(buf[j]>>4) & 0xf];
960 tstr[i*2 + 1] = DIGITS[buf[j]&0xf];
964 static int hextoint(int c)
975 LOG_ERROR("BUG: invalid register value %08x", c);
979 /* copy over in register buffer */
980 static void gdb_target_to_reg(struct target *target,
981 char *tstr, int str_len, uint8_t *bin)
985 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
990 for (i = 0; i < str_len; i += 2)
992 uint8_t t = hextoint(tstr[i]) << 4;
993 t |= hextoint(tstr[i + 1]);
995 int j = gdb_reg_pos(target, i/2, str_len/2);
1000 static int gdb_get_registers_packet(struct connection *connection,
1001 struct target *target, char* packet, int packet_size)
1003 struct reg **reg_list;
1006 int reg_packet_size = 0;
1011 #ifdef _DEBUG_GDB_IO_
1015 if ((retval = target_get_gdb_reg_list(target, ®_list, ®_list_size)) != ERROR_OK)
1017 return gdb_error(connection, retval);
1020 for (i = 0; i < reg_list_size; i++)
1022 reg_packet_size += reg_list[i]->size;
1025 reg_packet = malloc(DIV_ROUND_UP(reg_packet_size, 8) * 2);
1026 reg_packet_p = reg_packet;
1028 for (i = 0; i < reg_list_size; i++)
1030 gdb_str_to_target(target, reg_packet_p, reg_list[i]);
1031 reg_packet_p += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
1034 #ifdef _DEBUG_GDB_IO_
1037 reg_packet_p = strndup(reg_packet, DIV_ROUND_UP(reg_packet_size, 8) * 2);
1038 LOG_DEBUG("reg_packet: %s", reg_packet_p);
1043 gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_packet_size, 8) * 2);
1051 static int gdb_set_registers_packet(struct connection *connection,
1052 struct target *target, char *packet, int packet_size)
1055 struct reg **reg_list;
1060 #ifdef _DEBUG_GDB_IO_
1064 /* skip command character */
1068 if (packet_size % 2)
1070 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
1071 return ERROR_SERVER_REMOTE_CLOSED;
1074 if ((retval = target_get_gdb_reg_list(target, ®_list, ®_list_size)) != ERROR_OK)
1076 return gdb_error(connection, retval);
1080 for (i = 0; i < reg_list_size; i++)
1083 int chars = (DIV_ROUND_UP(reg_list[i]->size, 8) * 2);
1085 if (packet_p + chars > packet + packet_size)
1087 LOG_ERROR("BUG: register packet is too small for registers");
1090 bin_buf = malloc(DIV_ROUND_UP(reg_list[i]->size, 8));
1091 gdb_target_to_reg(target, packet_p, chars, bin_buf);
1093 reg_list[i]->type->set(reg_list[i], bin_buf);
1095 /* advance packet pointer */
1102 /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1105 gdb_put_packet(connection, "OK", 2);
1110 static int gdb_get_register_packet(struct connection *connection,
1111 struct target *target, char *packet, int packet_size)
1114 int reg_num = strtoul(packet + 1, NULL, 16);
1115 struct reg **reg_list;
1119 #ifdef _DEBUG_GDB_IO_
1123 if ((retval = target_get_gdb_reg_list(target, ®_list, ®_list_size)) != ERROR_OK)
1125 return gdb_error(connection, retval);
1128 if (reg_list_size <= reg_num)
1130 LOG_ERROR("gdb requested a non-existing register");
1134 reg_packet = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1136 gdb_str_to_target(target, reg_packet, reg_list[reg_num]);
1138 gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1146 static int gdb_set_register_packet(struct connection *connection,
1147 struct target *target, char *packet, int packet_size)
1151 int reg_num = strtoul(packet + 1, &separator, 16);
1152 struct reg **reg_list;
1158 if ((retval = target_get_gdb_reg_list(target, ®_list, ®_list_size)) != ERROR_OK)
1160 return gdb_error(connection, retval);
1163 if (reg_list_size < reg_num)
1165 LOG_ERROR("gdb requested a non-existing register");
1166 return ERROR_SERVER_REMOTE_CLOSED;
1169 if (*separator != '=')
1171 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1172 return ERROR_SERVER_REMOTE_CLOSED;
1175 /* convert from GDB-string (target-endian) to hex-string (big-endian) */
1176 bin_buf = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8));
1177 int chars = (DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1179 /* fix!!! add some sanity checks on packet size here */
1181 gdb_target_to_reg(target, separator + 1, chars, bin_buf);
1183 reg_list[reg_num]->type->set(reg_list[reg_num], bin_buf);
1185 gdb_put_packet(connection, "OK", 2);
1193 static int gdb_error(struct connection *connection, int retval)
1197 case ERROR_TARGET_DATA_ABORT:
1198 gdb_send_error(connection, EIO);
1200 case ERROR_TARGET_TRANSLATION_FAULT:
1201 gdb_send_error(connection, EFAULT);
1203 case ERROR_TARGET_UNALIGNED_ACCESS:
1204 gdb_send_error(connection, EFAULT);
1206 case ERROR_TARGET_NOT_HALTED:
1207 gdb_send_error(connection, EFAULT);
1210 /* This could be that the target reset itself. */
1211 LOG_ERROR("unexpected error %i", retval);
1212 gdb_send_error(connection, EFAULT);
1219 /* We don't have to worry about the default 2 second timeout for GDB packets,
1220 * because GDB breaks up large memory reads into smaller reads.
1222 * 8191 bytes by the looks of it. Why 8191 bytes instead of 8192?????
1224 static int gdb_read_memory_packet(struct connection *connection,
1225 struct target *target, char *packet, int packet_size)
1234 int retval = ERROR_OK;
1236 /* skip command character */
1239 addr = strtoul(packet, &separator, 16);
1241 if (*separator != ',')
1243 LOG_ERROR("incomplete read memory packet received, dropping connection");
1244 return ERROR_SERVER_REMOTE_CLOSED;
1247 len = strtoul(separator + 1, NULL, 16);
1249 buffer = malloc(len);
1251 LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1253 retval = target_read_buffer(target, addr, len, buffer);
1255 if ((retval != ERROR_OK)&&!gdb_report_data_abort)
1257 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1258 * At some point this might be fixed in GDB, in which case this code can be removed.
1260 * OpenOCD developers are acutely aware of this problem, but there is nothing
1261 * gained by involving the user in this problem that hopefully will get resolved
1264 * http://sourceware.org/cgi-bin/gnatsweb.pl?cmd = view%20audit-trail&database = gdb&pr = 2395
1266 * For now, the default is to fix up things to make current GDB versions work.
1267 * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1269 memset(buffer, 0, len);
1273 if (retval == ERROR_OK)
1275 hex_buffer = malloc(len * 2 + 1);
1278 for (i = 0; i < len; i++)
1280 uint8_t t = buffer[i];
1281 hex_buffer[2 * i] = DIGITS[(t >> 4) & 0xf];
1282 hex_buffer[2 * i + 1] = DIGITS[t & 0xf];
1285 gdb_put_packet(connection, hex_buffer, len * 2);
1291 retval = gdb_error(connection, retval);
1299 static int gdb_write_memory_packet(struct connection *connection,
1300 struct target *target, char *packet, int packet_size)
1311 /* skip command character */
1314 addr = strtoul(packet, &separator, 16);
1316 if (*separator != ',')
1318 LOG_ERROR("incomplete write memory packet received, dropping connection");
1319 return ERROR_SERVER_REMOTE_CLOSED;
1322 len = strtoul(separator + 1, &separator, 16);
1324 if (*(separator++) != ':')
1326 LOG_ERROR("incomplete write memory packet received, dropping connection");
1327 return ERROR_SERVER_REMOTE_CLOSED;
1330 buffer = malloc(len);
1332 LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1334 for (i = 0; i < len; i++)
1337 sscanf(separator + 2*i, "%2" SCNx32 , &tmp);
1341 retval = target_write_buffer(target, addr, len, buffer);
1343 if (retval == ERROR_OK)
1345 gdb_put_packet(connection, "OK", 2);
1349 retval = gdb_error(connection, retval);
1357 static int gdb_write_memory_binary_packet(struct connection *connection,
1358 struct target *target, char *packet, int packet_size)
1366 /* skip command character */
1369 addr = strtoul(packet, &separator, 16);
1371 if (*separator != ',')
1373 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1374 return ERROR_SERVER_REMOTE_CLOSED;
1377 len = strtoul(separator + 1, &separator, 16);
1379 if (*(separator++) != ':')
1381 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1382 return ERROR_SERVER_REMOTE_CLOSED;
1388 LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1390 retval = target_write_buffer(target, addr, len, (uint8_t*)separator);
1393 if (retval == ERROR_OK)
1395 gdb_put_packet(connection, "OK", 2);
1399 if ((retval = gdb_error(connection, retval)) != ERROR_OK)
1406 static int gdb_step_continue_packet(struct connection *connection,
1407 struct target *target, char *packet, int packet_size)
1410 uint32_t address = 0x0;
1411 int retval = ERROR_OK;
1415 if (packet_size > 1)
1417 packet[packet_size] = 0;
1418 address = strtoul(packet + 1, NULL, 16);
1425 if (packet[0] == 'c')
1427 LOG_DEBUG("continue");
1428 target_handle_event(target, TARGET_EVENT_OLD_pre_resume);
1429 retval = target_resume(target, current, address, 0, 0); /* resume at current address, don't handle breakpoints, not debugging */
1431 else if (packet[0] == 's')
1434 /* step at current or address, don't handle breakpoints */
1435 retval = target_step(target, current, address, 0);
1440 static int gdb_breakpoint_watchpoint_packet(struct connection *connection,
1441 struct target *target, char *packet, int packet_size)
1444 enum breakpoint_type bp_type = BKPT_SOFT /* dummy init to avoid warning */;
1445 enum watchpoint_rw wp_type = WPT_READ /* dummy init to avoid warning */;
1453 type = strtoul(packet + 1, &separator, 16);
1455 if (type == 0) /* memory breakpoint */
1456 bp_type = BKPT_SOFT;
1457 else if (type == 1) /* hardware breakpoint */
1458 bp_type = BKPT_HARD;
1459 else if (type == 2) /* write watchpoint */
1460 wp_type = WPT_WRITE;
1461 else if (type == 3) /* read watchpoint */
1463 else if (type == 4) /* access watchpoint */
1464 wp_type = WPT_ACCESS;
1467 LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type);
1468 return ERROR_SERVER_REMOTE_CLOSED;
1472 if (gdb_breakpoint_override && ((bp_type == BKPT_SOFT)||(bp_type == BKPT_HARD)))
1474 bp_type = gdb_breakpoint_override_type;
1477 if (*separator != ',')
1479 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1480 return ERROR_SERVER_REMOTE_CLOSED;
1483 address = strtoul(separator + 1, &separator, 16);
1485 if (*separator != ',')
1487 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1488 return ERROR_SERVER_REMOTE_CLOSED;
1491 size = strtoul(separator + 1, &separator, 16);
1497 if (packet[0] == 'Z')
1499 if ((retval = breakpoint_add(target, address, size, bp_type)) != ERROR_OK)
1501 if ((retval = gdb_error(connection, retval)) != ERROR_OK)
1506 gdb_put_packet(connection, "OK", 2);
1511 breakpoint_remove(target, address);
1512 gdb_put_packet(connection, "OK", 2);
1519 if (packet[0] == 'Z')
1521 if ((retval = watchpoint_add(target, address, size, wp_type, 0, 0xffffffffu)) != ERROR_OK)
1523 if ((retval = gdb_error(connection, retval)) != ERROR_OK)
1528 gdb_put_packet(connection, "OK", 2);
1533 watchpoint_remove(target, address);
1534 gdb_put_packet(connection, "OK", 2);
1545 /* print out a string and allocate more space as needed,
1546 * mainly used for XML at this point
1548 static void xml_printf(int *retval, char **xml, int *pos, int *size,
1549 const char *fmt, ...)
1551 if (*retval != ERROR_OK)
1559 if ((*xml == NULL) || (!first))
1561 /* start by 0 to exercise all the code paths.
1562 * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1564 *size = *size * 2 + 2;
1566 *xml = realloc(*xml, *size);
1571 *retval = ERROR_SERVER_REMOTE_CLOSED;
1579 ret = vsnprintf(*xml + *pos, *size - *pos, fmt, ap);
1581 if ((ret > 0) && ((ret + 1) < *size - *pos))
1586 /* there was just enough or not enough space, allocate more. */
1591 static int decode_xfer_read(char *buf, char **annex, int *ofs, unsigned int *len)
1595 /* Extract and NUL-terminate the annex. */
1597 while (*buf && *buf != ':')
1603 /* After the read marker and annex, qXfer looks like a
1604 * traditional 'm' packet. */
1606 *ofs = strtoul(buf, &separator, 16);
1608 if (*separator != ',')
1611 *len = strtoul(separator + 1, NULL, 16);
1616 static int gdb_calc_blocksize(struct flash_bank *bank)
1619 uint32_t block_size = 0xffffffff;
1621 /* loop through all sectors and return smallest sector size */
1623 for (i = 0; i < (uint32_t)bank->num_sectors; i++)
1625 if (bank->sectors[i].size < block_size)
1626 block_size = bank->sectors[i].size;
1632 static int compare_bank (const void * a, const void * b)
1634 struct flash_bank *b1, *b2;
1635 b1=*((struct flash_bank **)a);
1636 b2=*((struct flash_bank **)b);
1638 if (b1->base == b2->base)
1641 } else if (b1->base > b2->base)
1650 static int gdb_memory_map(struct connection *connection,
1651 struct target *target, char *packet, int packet_size)
1653 /* We get away with only specifying flash here. Regions that are not
1654 * specified are treated as if we provided no memory map(if not we
1655 * could detect the holes and mark them as RAM).
1656 * Normally we only execute this code once, but no big deal if we
1657 * have to regenerate it a couple of times.
1660 struct flash_bank *p;
1664 int retval = ERROR_OK;
1665 struct flash_bank **banks;
1670 uint32_t ram_start = 0;
1673 /* skip command character */
1676 offset = strtoul(packet, &separator, 16);
1677 length = strtoul(separator + 1, &separator, 16);
1679 xml_printf(&retval, &xml, &pos, &size, "<memory-map>\n");
1681 /* Sort banks in ascending order. We need to report non-flash
1682 * memory as ram (or rather read/write) by default for GDB, since
1683 * it has no concept of non-cacheable read/write memory (i/o etc).
1685 * FIXME Most non-flash addresses are *NOT* RAM! Don't lie.
1687 banks = malloc(sizeof(struct flash_bank *)*flash_get_bank_count());
1689 for (i = 0; i < flash_get_bank_count(); i++) {
1690 p = get_flash_bank_by_num(i);
1693 retval = ERROR_FAIL;
1694 gdb_send_error(connection, retval);
1700 qsort(banks, flash_get_bank_count(), sizeof(struct flash_bank *),
1703 for (i = 0; i < flash_get_bank_count(); i++) {
1706 if (ram_start < p->base)
1707 xml_printf(&retval, &xml, &pos, &size,
1708 "<memory type=\"ram\" start=\"0x%x\" "
1709 "length=\"0x%x\"/>\n",
1710 ram_start, p->base-ram_start);
1712 /* If device has uneven sector sizes, eg. str7, lpc
1713 * we pass the smallest sector size to gdb memory map
1715 * FIXME Don't lie about flash regions with different
1716 * sector sizes; just tell GDB about each region as
1717 * if it were a separate flash device.
1719 blocksize = gdb_calc_blocksize(p);
1721 xml_printf(&retval, &xml, &pos, &size,
1722 "<memory type=\"flash\" start=\"0x%x\" "
1723 "length=\"0x%x\">\n" \
1724 "<property name=\"blocksize\">0x%x</property>\n" \
1726 p->base, p->size, blocksize);
1727 ram_start = p->base + p->size;
1731 xml_printf(&retval, &xml, &pos, &size,
1732 "<memory type=\"ram\" start=\"0x%x\" "
1733 "length=\"0x%x\"/>\n",
1734 ram_start, 0-ram_start);
1735 /* ELSE a flash chip could be at the very end of the 32 bit address
1736 * space, in which case ram_start will be precisely 0
1742 xml_printf(&retval, &xml, &pos, &size, "</memory-map>\n");
1744 if (retval != ERROR_OK) {
1745 gdb_send_error(connection, retval);
1749 if (offset + length > pos)
1750 length = pos - offset;
1752 char *t = malloc(length + 1);
1754 memcpy(t + 1, xml + offset, length);
1755 gdb_put_packet(connection, t, length + 1);
1762 static int gdb_query_packet(struct connection *connection,
1763 struct target *target, char *packet, int packet_size)
1765 struct command_context *cmd_ctx = connection->cmd_ctx;
1766 struct gdb_connection *gdb_connection = connection->priv;
1768 if (strstr(packet, "qRcmd,"))
1770 if (packet_size > 6)
1774 cmd = malloc((packet_size - 6)/2 + 1);
1775 for (i = 0; i < (packet_size - 6)/2; i++)
1778 sscanf(packet + 6 + 2*i, "%2" SCNx32 , &tmp);
1781 cmd[(packet_size - 6)/2] = 0x0;
1783 /* We want to print all debug output to GDB connection */
1784 log_add_callback(gdb_log_callback, connection);
1785 target_call_timer_callbacks_now();
1786 /* some commands need to know the GDB connection, make note of current
1787 * GDB connection. */
1788 current_gdb_connection = gdb_connection;
1789 command_run_line(cmd_ctx, cmd);
1790 current_gdb_connection = NULL;
1791 target_call_timer_callbacks_now();
1792 log_remove_callback(gdb_log_callback, connection);
1795 gdb_put_packet(connection, "OK", 2);
1798 else if (strstr(packet, "qCRC:"))
1800 if (packet_size > 5)
1809 /* skip command character */
1812 addr = strtoul(packet, &separator, 16);
1814 if (*separator != ',')
1816 LOG_ERROR("incomplete read memory packet received, dropping connection");
1817 return ERROR_SERVER_REMOTE_CLOSED;
1820 len = strtoul(separator + 1, NULL, 16);
1822 retval = target_checksum_memory(target, addr, len, &checksum);
1824 if (retval == ERROR_OK)
1826 snprintf(gdb_reply, 10, "C%8.8" PRIx32 "", checksum);
1827 gdb_put_packet(connection, gdb_reply, 9);
1831 if ((retval = gdb_error(connection, retval)) != ERROR_OK)
1838 else if (strstr(packet, "qSupported"))
1840 /* we currently support packet size and qXfer:memory-map:read (if enabled)
1841 * disable qXfer:features:read for the moment */
1842 int retval = ERROR_OK;
1843 char *buffer = NULL;
1847 xml_printf(&retval, &buffer, &pos, &size,
1848 "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read-;QStartNoAckMode+",
1849 (GDB_BUFFER_SIZE - 1), ((gdb_use_memory_map == 1) && (flash_get_bank_count() > 0)) ? '+' : '-');
1851 if (retval != ERROR_OK)
1853 gdb_send_error(connection, 01);
1857 gdb_put_packet(connection, buffer, strlen(buffer));
1862 else if (strstr(packet, "qXfer:memory-map:read::")
1863 && (flash_get_bank_count() > 0))
1864 return gdb_memory_map(connection, target, packet, packet_size);
1865 else if (strstr(packet, "qXfer:features:read:"))
1870 int retval = ERROR_OK;
1873 unsigned int length;
1876 /* skip command character */
1879 if (decode_xfer_read(packet, &annex, &offset, &length) < 0)
1881 gdb_send_error(connection, 01);
1885 if (strcmp(annex, "target.xml") != 0)
1887 gdb_send_error(connection, 01);
1891 xml_printf(&retval, &xml, &pos, &size, \
1892 "l < target version=\"1.0\">\n < architecture > arm</architecture>\n</target>\n");
1894 if (retval != ERROR_OK)
1896 gdb_send_error(connection, retval);
1900 gdb_put_packet(connection, xml, strlen(xml));
1905 else if (strstr(packet, "QStartNoAckMode"))
1907 gdb_connection->noack_mode = 1;
1908 gdb_put_packet(connection, "OK", 2);
1912 gdb_put_packet(connection, "", 0);
1916 static int gdb_v_packet(struct connection *connection,
1917 struct target *target, char *packet, int packet_size)
1919 struct gdb_connection *gdb_connection = connection->priv;
1920 struct gdb_service *gdb_service = connection->service->priv;
1923 /* if flash programming disabled - send a empty reply */
1925 if (gdb_flash_program == 0)
1927 gdb_put_packet(connection, "", 0);
1931 if (strstr(packet, "vFlashErase:"))
1934 unsigned long length;
1936 char *parse = packet + 12;
1939 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1940 return ERROR_SERVER_REMOTE_CLOSED;
1943 addr = strtoul(parse, &parse, 16);
1945 if (*(parse++) != ',' || *parse == '\0')
1947 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1948 return ERROR_SERVER_REMOTE_CLOSED;
1951 length = strtoul(parse, &parse, 16);
1955 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1956 return ERROR_SERVER_REMOTE_CLOSED;
1959 /* assume all sectors need erasing - stops any problems
1960 * when flash_write is called multiple times */
1963 /* perform any target specific operations before the erase */
1964 target_call_event_callbacks(gdb_service->target,
1965 TARGET_EVENT_GDB_FLASH_ERASE_START);
1967 /* vFlashErase:addr,length messages require region start and
1968 * end to be "block" aligned ... if padding is ever needed,
1969 * GDB will have become dangerously confused.
1971 result = flash_erase_address_range(gdb_service->target,
1972 false, addr, length);
1974 /* perform any target specific operations after the erase */
1975 target_call_event_callbacks(gdb_service->target,
1976 TARGET_EVENT_GDB_FLASH_ERASE_END);
1979 if (result != ERROR_OK)
1981 /* GDB doesn't evaluate the actual error number returned,
1982 * treat a failed erase as an I/O error
1984 gdb_send_error(connection, EIO);
1985 LOG_ERROR("flash_erase returned %i", result);
1988 gdb_put_packet(connection, "OK", 2);
1993 if (strstr(packet, "vFlashWrite:"))
1997 unsigned long length;
1998 char *parse = packet + 12;
2002 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2003 return ERROR_SERVER_REMOTE_CLOSED;
2005 addr = strtoul(parse, &parse, 16);
2006 if (*(parse++) != ':')
2008 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2009 return ERROR_SERVER_REMOTE_CLOSED;
2011 length = packet_size - (parse - packet);
2013 /* create a new image if there isn't already one */
2014 if (gdb_connection->vflash_image == NULL)
2016 gdb_connection->vflash_image = malloc(sizeof(struct image));
2017 image_open(gdb_connection->vflash_image, "", "build");
2020 /* create new section with content from packet buffer */
2021 if ((retval = image_add_section(gdb_connection->vflash_image, addr, length, 0x0, (uint8_t*)parse)) != ERROR_OK)
2026 gdb_put_packet(connection, "OK", 2);
2031 if (!strcmp(packet, "vFlashDone"))
2035 /* process the flashing buffer. No need to erase as GDB
2036 * always issues a vFlashErase first. */
2037 target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_WRITE_START);
2038 result = flash_write(gdb_service->target, gdb_connection->vflash_image, &written, 0);
2039 target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_WRITE_END);
2040 if (result != ERROR_OK)
2042 if (result == ERROR_FLASH_DST_OUT_OF_BANK)
2043 gdb_put_packet(connection, "E.memtype", 9);
2045 gdb_send_error(connection, EIO);
2049 LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written);
2050 gdb_put_packet(connection, "OK", 2);
2053 image_close(gdb_connection->vflash_image);
2054 free(gdb_connection->vflash_image);
2055 gdb_connection->vflash_image = NULL;
2060 gdb_put_packet(connection, "", 0);
2064 static int gdb_detach(struct connection *connection, struct target *target)
2066 struct gdb_service *gdb_service = connection->service->priv;
2068 target_call_event_callbacks(gdb_service->target,
2069 TARGET_EVENT_GDB_DETACH);
2071 return gdb_put_packet(connection, "OK", 2);
2074 static void gdb_log_callback(void *priv, const char *file, unsigned line,
2075 const char *function, const char *string)
2077 struct connection *connection = priv;
2078 struct gdb_connection *gdb_con = connection->priv;
2082 /* do not reply this using the O packet */
2086 gdb_output_con(connection, string);
2089 static void gdb_sig_halted(struct connection *connection)
2092 snprintf(sig_reply, 4, "T%2.2x", 2);
2093 gdb_put_packet(connection, sig_reply, 3);
2097 static int gdb_input_inner(struct connection *connection)
2099 /* Do not allocate this on the stack */
2100 static char gdb_packet_buffer[GDB_BUFFER_SIZE];
2102 struct gdb_service *gdb_service = connection->service->priv;
2103 struct target *target = gdb_service->target;
2104 char *packet = gdb_packet_buffer;
2107 struct gdb_connection *gdb_con = connection->priv;
2108 static int extended_protocol = 0;
2110 /* drain input buffer */
2113 packet_size = GDB_BUFFER_SIZE-1;
2114 retval = gdb_get_packet(connection, packet, &packet_size);
2115 if (retval != ERROR_OK)
2118 /* terminate with zero */
2119 packet[packet_size] = 0;
2121 if (LOG_LEVEL_IS(LOG_LVL_DEBUG)) {
2122 if (packet[0] == 'X') {
2123 // binary packets spew junk into the debug log stream
2126 for (x = 0 ; (x < 49) && (packet[x] != ':') ; x++) {
2130 LOG_DEBUG("received packet: '%s:<binary-data>'", buf);
2132 LOG_DEBUG("received packet: '%s'", packet);
2136 if (packet_size > 0)
2142 /* Hct... -- set thread
2143 * we don't have threads, send empty reply */
2144 gdb_put_packet(connection, NULL, 0);
2148 retval = gdb_query_packet(connection,
2153 retval = gdb_get_registers_packet(
2155 packet, packet_size);
2158 retval = gdb_set_registers_packet(
2160 packet, packet_size);
2163 retval = gdb_get_register_packet(
2165 packet, packet_size);
2168 retval = gdb_set_register_packet(
2170 packet, packet_size);
2173 retval = gdb_read_memory_packet(
2175 packet, packet_size);
2178 retval = gdb_write_memory_packet(
2180 packet, packet_size);
2184 retval = gdb_breakpoint_watchpoint_packet(connection, target, packet, packet_size);
2187 gdb_last_signal_packet(
2189 packet, packet_size);
2194 int retval = ERROR_OK;
2196 struct gdb_connection *gdb_con = connection->priv;
2197 log_add_callback(gdb_log_callback, connection);
2199 bool nostep = false;
2200 if (target->state == TARGET_RUNNING)
2202 LOG_WARNING("The target is already running. Halt target before stepi/continue.");
2203 retval = target_halt(target);
2204 if (retval == ERROR_OK)
2205 retval = target_wait_state(target, TARGET_HALTED, 100);
2206 } else if (target->state != TARGET_HALTED)
2208 LOG_WARNING("The target is not in the halted nor running stated, stepi/continue ignored.");
2210 } else if ((packet[0] == 's') && gdb_con->sync)
2212 /* Hmm..... when you issue a continue in GDB, then a "stepi" is
2213 * sent by GDB first to OpenOCD, thus defeating the check to
2214 * make only the single stepping have the sync feature...
2217 LOG_WARNING("stepi ignored. GDB will now fetch the register state from the target.");
2219 gdb_con->sync = false;
2221 if ((retval!=ERROR_OK) || nostep)
2223 /* Either the target isn't in the halted state, then we can't
2224 * step/continue. This might be early setup, etc.
2226 * Or we want to allow GDB to pick up a fresh set of
2227 * register values without modifying the target state.
2230 gdb_sig_halted(connection);
2232 /* stop forwarding log packets! */
2233 log_remove_callback(gdb_log_callback, connection);
2236 /* We're running/stepping, in which case we can
2237 * forward log output until the target is halted
2239 gdb_con->frontend_state = TARGET_RUNNING;
2240 target_call_event_callbacks(target, TARGET_EVENT_GDB_START);
2241 int retval = gdb_step_continue_packet(connection, target, packet, packet_size);
2242 if (retval != ERROR_OK)
2244 /* we'll never receive a halted condition... issue a false one.. */
2245 gdb_frontend_halted(target, connection);
2251 retval = gdb_v_packet(
2253 packet, packet_size);
2256 retval = gdb_detach(connection, target);
2257 extended_protocol = 0;
2260 retval = gdb_write_memory_binary_packet(
2262 packet, packet_size);
2263 if (retval != ERROR_OK)
2267 if (extended_protocol != 0)
2269 gdb_put_packet(connection, "OK", 2);
2270 return ERROR_SERVER_REMOTE_CLOSED;
2272 /* handle extended remote protocol */
2273 extended_protocol = 1;
2274 gdb_put_packet(connection, "OK", 2);
2277 /* handle extended restart packet */
2278 breakpoint_clear_target(gdb_service->target);
2279 watchpoint_clear_target(gdb_service->target);
2280 command_run_linef(connection->cmd_ctx,
2281 "ocd_gdb_restart %s",
2282 target_name(target));
2285 /* ignore unknown packets */
2286 LOG_DEBUG("ignoring 0x%2.2x packet", packet[0]);
2287 gdb_put_packet(connection, NULL, 0);
2291 /* if a packet handler returned an error, exit input loop */
2292 if (retval != ERROR_OK)
2296 if (gdb_con->ctrl_c)
2298 if (target->state == TARGET_RUNNING)
2300 retval = target_halt(target);
2301 if (retval != ERROR_OK)
2303 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2305 gdb_con->ctrl_c = 0;
2308 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
2309 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2313 } while (gdb_con->buf_cnt > 0);
2318 static int gdb_input(struct connection *connection)
2320 int retval = gdb_input_inner(connection);
2321 struct gdb_connection *gdb_con = connection->priv;
2322 if (retval == ERROR_SERVER_REMOTE_CLOSED)
2325 /* logging does not propagate the error, yet can set the gdb_con->closed flag */
2326 if (gdb_con->closed)
2327 return ERROR_SERVER_REMOTE_CLOSED;
2329 /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
2333 static int gdb_target_start(struct target *target, uint16_t port)
2335 bool use_pipes = 0 == port;
2336 struct gdb_service *gdb_service = malloc(sizeof(struct gdb_service));
2337 if (NULL == gdb_service)
2340 gdb_service->target = target;
2342 add_service("gdb", use_pipes ? CONNECTION_PIPE : CONNECTION_TCP,
2343 port, 1, &gdb_new_connection, &gdb_input,
2344 &gdb_connection_closed, gdb_service);
2346 const char *name = target_name(target);
2348 LOG_DEBUG("gdb service for target '%s' using pipes", name);
2350 LOG_DEBUG("gdb service for target '%s' on TCP port %u", name, port);
2354 static int gdb_target_add_one(struct target *target)
2356 if (gdb_port == 0 && server_use_pipes == 0)
2358 LOG_INFO("gdb port disabled");
2361 if (0 == gdb_port_next)
2362 gdb_port_next = gdb_port;
2364 bool use_pipes = server_use_pipes;
2365 static bool server_started_with_pipes = false;
2366 if (server_started_with_pipes)
2368 LOG_WARNING("gdb service permits one target when using pipes");
2375 int e = gdb_target_start(target, use_pipes ? 0 : gdb_port_next);
2378 server_started_with_pipes |= use_pipes;
2384 int gdb_target_add_all(struct target *target)
2388 LOG_WARNING("gdb services need one or more targets defined");
2392 while (NULL != target)
2394 int retval = gdb_target_add_one(target);
2395 if (ERROR_OK != retval)
2398 target = target->next;
2404 COMMAND_HANDLER(handle_gdb_sync_command)
2408 return ERROR_COMMAND_SYNTAX_ERROR;
2411 if (current_gdb_connection == NULL)
2413 command_print(CMD_CTX,
2414 "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
2418 current_gdb_connection->sync = true;
2423 /* daemon configuration command gdb_port */
2424 COMMAND_HANDLER(handle_gdb_port_command)
2426 int retval = CALL_COMMAND_HANDLER(server_port_command, &gdb_port);
2427 if (ERROR_OK == retval)
2428 gdb_port_next = gdb_port;
2432 COMMAND_HANDLER(handle_gdb_memory_map_command)
2435 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_memory_map);
2437 return ERROR_COMMAND_SYNTAX_ERROR;
2440 COMMAND_HANDLER(handle_gdb_flash_program_command)
2443 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_flash_program);
2445 return ERROR_COMMAND_SYNTAX_ERROR;
2448 COMMAND_HANDLER(handle_gdb_report_data_abort_command)
2451 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_data_abort);
2453 return ERROR_COMMAND_SYNTAX_ERROR;
2456 /* gdb_breakpoint_override */
2457 COMMAND_HANDLER(handle_gdb_breakpoint_override_command)
2462 } else if (CMD_ARGC == 1)
2464 gdb_breakpoint_override = 1;
2465 if (strcmp(CMD_ARGV[0], "hard") == 0)
2467 gdb_breakpoint_override_type = BKPT_HARD;
2468 } else if (strcmp(CMD_ARGV[0], "soft") == 0)
2470 gdb_breakpoint_override_type = BKPT_SOFT;
2471 } else if (strcmp(CMD_ARGV[0], "disable") == 0)
2473 gdb_breakpoint_override = 0;
2477 return ERROR_COMMAND_SYNTAX_ERROR;
2479 if (gdb_breakpoint_override)
2481 LOG_USER("force %s breakpoints", (gdb_breakpoint_override_type == BKPT_HARD)?"hard":"soft");
2484 LOG_USER("breakpoint type is not overridden");
2490 static const struct command_registration gdb_command_handlers[] = {
2493 .handler = handle_gdb_sync_command,
2494 .mode = COMMAND_ANY,
2495 .help = "next stepi will return immediately allowing "
2496 "GDB to fetch register state without affecting "
2501 .handler = handle_gdb_port_command,
2502 .mode = COMMAND_ANY,
2503 .help = "Display or specify base port on which to listen "
2504 "for incoming GDB connections. "
2505 "No arguments reports GDB port; zero disables.",
2506 .usage = "[port_num]",
2509 .name = "gdb_memory_map",
2510 .handler = handle_gdb_memory_map_command,
2511 .mode = COMMAND_CONFIG,
2512 .help = "enable or disable memory map",
2513 .usage = "('enable'|'disable')"
2516 .name = "gdb_flash_program",
2517 .handler = handle_gdb_flash_program_command,
2518 .mode = COMMAND_CONFIG,
2519 .help = "enable or disable flash program",
2520 .usage = "('enable'|'disable')"
2523 .name = "gdb_report_data_abort",
2524 .handler = handle_gdb_report_data_abort_command,
2525 .mode = COMMAND_CONFIG,
2526 .help = "enable or disable reporting data aborts",
2527 .usage = "('enable'|'disable')"
2530 .name = "gdb_breakpoint_override",
2531 .handler = handle_gdb_breakpoint_override_command,
2532 .mode = COMMAND_ANY,
2533 .help = "Display or specify type of breakpoint "
2534 "to be used by gdb 'break' commands.",
2535 .usage = "('hard'|'soft'|'disable')"
2537 COMMAND_REGISTRATION_DONE
2540 int gdb_register_commands(struct command_context *cmd_ctx)
2542 return register_commands(cmd_ctx, NULL, gdb_command_handlers);