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 extern 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 int gdb_use_memory_map
= 1;
93 /* enabled by default*/
94 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 int gdb_report_data_abort
= 0;
100 int gdb_last_signal(struct target
*target
)
102 switch (target
->debug_reason
)
104 case DBG_REASON_DBGRQ
:
105 return 0x2; /* SIGINT */
106 case DBG_REASON_BREAKPOINT
:
107 case DBG_REASON_WATCHPOINT
:
108 case DBG_REASON_WPTANDBKPT
:
109 return 0x05; /* SIGTRAP */
110 case DBG_REASON_SINGLESTEP
:
111 return 0x05; /* SIGTRAP */
112 case DBG_REASON_NOTHALTED
:
113 return 0x0; /* no signal... shouldn't happen */
115 LOG_USER("undefined debug reason %d - target needs reset", target
->debug_reason
);
120 int check_pending(struct connection
*connection
, int timeout_s
, int *got_data
)
122 /* a non-blocking socket will block if there is 0 bytes available on the socket,
123 * but return with as many bytes as are available immediately
127 struct gdb_connection
*gdb_con
= connection
->priv
;
129 if (got_data
== NULL
)
133 if (gdb_con
->buf_cnt
> 0)
140 FD_SET(connection
->fd
, &read_fds
);
142 tv
.tv_sec
= timeout_s
;
144 if (socket_select(connection
->fd
+ 1, &read_fds
, NULL
, NULL
, &tv
) == 0)
146 /* This can typically be because a "monitor" command took too long
147 * before printing any progress messages
151 return ERROR_GDB_TIMEOUT
;
157 *got_data
= FD_ISSET(connection
->fd
, &read_fds
) != 0;
161 static int gdb_get_char_inner(struct connection
*connection
, int* next_char
)
163 struct gdb_connection
*gdb_con
= connection
->priv
;
164 int retval
= ERROR_OK
;
168 if (connection
->service
->type
== CONNECTION_PIPE
)
170 gdb_con
->buf_cnt
= read(connection
->fd
, gdb_con
->buffer
, GDB_BUFFER_SIZE
);
174 retval
= check_pending(connection
, 1, NULL
);
175 if (retval
!= ERROR_OK
)
177 gdb_con
->buf_cnt
= read_socket(connection
->fd
, gdb_con
->buffer
, GDB_BUFFER_SIZE
);
180 if (gdb_con
->buf_cnt
> 0)
184 if (gdb_con
->buf_cnt
== 0)
187 return ERROR_SERVER_REMOTE_CLOSED
;
191 errno
= WSAGetLastError();
198 case WSAECONNABORTED
:
200 return ERROR_SERVER_REMOTE_CLOSED
;
203 return ERROR_SERVER_REMOTE_CLOSED
;
205 LOG_ERROR("read: %d", errno
);
216 return ERROR_SERVER_REMOTE_CLOSED
;
219 return ERROR_SERVER_REMOTE_CLOSED
;
221 LOG_ERROR("read: %s", strerror(errno
));
223 return ERROR_SERVER_REMOTE_CLOSED
;
228 #ifdef _DEBUG_GDB_IO_
229 debug_buffer
= malloc(gdb_con
->buf_cnt
+ 1);
230 memcpy(debug_buffer
, gdb_con
->buffer
, gdb_con
->buf_cnt
);
231 debug_buffer
[gdb_con
->buf_cnt
] = 0;
232 LOG_DEBUG("received '%s'", debug_buffer
);
236 gdb_con
->buf_p
= gdb_con
->buffer
;
238 *next_char
= *(gdb_con
->buf_p
++);
239 if (gdb_con
->buf_cnt
> 0)
240 connection
->input_pending
= 1;
242 connection
->input_pending
= 0;
243 #ifdef _DEBUG_GDB_IO_
244 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char
, *next_char
);
251 * The cool thing about this fn is that it allows buf_p and buf_cnt to be
252 * held in registers in the inner loop.
254 * For small caches and embedded systems this is important!
256 static inline int gdb_get_char_fast(struct connection
*connection
, int* next_char
, char **buf_p
, int *buf_cnt
)
258 int retval
= ERROR_OK
;
260 if ((*buf_cnt
)-- > 0)
262 *next_char
= **buf_p
;
265 connection
->input_pending
= 1;
267 connection
->input_pending
= 0;
269 #ifdef _DEBUG_GDB_IO_
270 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char
, *next_char
);
276 struct gdb_connection
*gdb_con
= connection
->priv
;
277 gdb_con
->buf_p
= *buf_p
;
278 gdb_con
->buf_cnt
= *buf_cnt
;
279 retval
= gdb_get_char_inner(connection
, next_char
);
280 *buf_p
= gdb_con
->buf_p
;
281 *buf_cnt
= gdb_con
->buf_cnt
;
287 int gdb_get_char(struct connection
*connection
, int* next_char
)
289 struct gdb_connection
*gdb_con
= connection
->priv
;
290 return gdb_get_char_fast(connection
, next_char
, &gdb_con
->buf_p
, &gdb_con
->buf_cnt
);
294 int gdb_putback_char(struct connection
*connection
, int last_char
)
296 struct gdb_connection
*gdb_con
= connection
->priv
;
298 if (gdb_con
->buf_p
> gdb_con
->buffer
)
300 *(--gdb_con
->buf_p
) = last_char
;
305 LOG_ERROR("BUG: couldn't put character back");
311 /* The only way we can detect that the socket is closed is the first time
312 * we write to it, we will fail. Subsequent write operations will
313 * succeed. Shudder! */
314 int gdb_write(struct connection
*connection
, void *data
, int len
)
316 struct gdb_connection
*gdb_con
= connection
->priv
;
318 return ERROR_SERVER_REMOTE_CLOSED
;
320 if (connection
->service
->type
== CONNECTION_PIPE
)
322 /* write to stdout */
323 if (write(STDOUT_FILENO
, data
, len
) == len
)
330 if (write_socket(connection
->fd
, data
, len
) == len
)
336 return ERROR_SERVER_REMOTE_CLOSED
;
339 int gdb_put_packet_inner(struct connection
*connection
, char *buffer
, int len
)
342 unsigned char my_checksum
= 0;
343 #ifdef _DEBUG_GDB_IO_
348 struct gdb_connection
*gdb_con
= connection
->priv
;
350 for (i
= 0; i
< len
; i
++)
351 my_checksum
+= buffer
[i
];
353 #ifdef _DEBUG_GDB_IO_
355 * At this point we should have nothing in the input queue from GDB,
356 * however sometimes '-' is sent even though we've already received
357 * an ACK (+) for everything we've sent off.
362 if ((retval
= check_pending(connection
, 0, &gotdata
)) != ERROR_OK
)
366 if ((retval
= gdb_get_char(connection
, &reply
)) != ERROR_OK
)
369 /* fix a problem with some IAR tools */
370 gdb_putback_char(connection
, reply
);
371 LOG_DEBUG("Unexpected start of new packet");
375 LOG_WARNING("Discard unexpected char %c", reply
);
381 #ifdef _DEBUG_GDB_IO_
382 debug_buffer
= malloc(len
+ 1);
383 memcpy(debug_buffer
, buffer
, len
);
384 debug_buffer
[len
] = 0;
385 LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer
, my_checksum
);
389 char local_buffer
[1024];
390 local_buffer
[0] = '$';
391 if ((size_t)len
+ 4 <= sizeof(local_buffer
))
393 /* performance gain on smaller packets by only a single call to gdb_write() */
394 memcpy(local_buffer
+ 1, buffer
, len
++);
395 local_buffer
[len
++] = '#';
396 local_buffer
[len
++] = DIGITS
[(my_checksum
>> 4) & 0xf];
397 local_buffer
[len
++] = DIGITS
[my_checksum
& 0xf];
398 if ((retval
= gdb_write(connection
, local_buffer
, len
)) != ERROR_OK
)
405 /* larger packets are transmitted directly from caller supplied buffer
406 by several calls to gdb_write() to avoid dynamic allocation */
407 local_buffer
[1] = '#';
408 local_buffer
[2] = DIGITS
[(my_checksum
>> 4) & 0xf];
409 local_buffer
[3] = DIGITS
[my_checksum
& 0xf];
410 if ((retval
= gdb_write(connection
, local_buffer
, 1)) != ERROR_OK
)
414 if ((retval
= gdb_write(connection
, buffer
, len
)) != ERROR_OK
)
418 if ((retval
= gdb_write(connection
, local_buffer
+ 1, 3)) != ERROR_OK
)
424 if (gdb_con
->noack_mode
)
427 if ((retval
= gdb_get_char(connection
, &reply
)) != ERROR_OK
)
432 else if (reply
== '-')
434 /* Stop sending output packets for now */
435 log_remove_callback(gdb_log_callback
, connection
);
436 LOG_WARNING("negative reply, retrying");
438 else if (reply
== 0x3)
441 if ((retval
= gdb_get_char(connection
, &reply
)) != ERROR_OK
)
445 else if (reply
== '-')
447 /* Stop sending output packets for now */
448 log_remove_callback(gdb_log_callback
, connection
);
449 LOG_WARNING("negative reply, retrying");
451 else if (reply
== '$') {
452 LOG_ERROR("GDB missing ack(1) - assumed good");
453 gdb_putback_char(connection
, reply
);
457 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply
);
459 return ERROR_SERVER_REMOTE_CLOSED
;
462 else if (reply
== '$') {
463 LOG_ERROR("GDB missing ack(2) - assumed good");
464 gdb_putback_char(connection
, reply
);
469 LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection", reply
);
471 return ERROR_SERVER_REMOTE_CLOSED
;
475 return ERROR_SERVER_REMOTE_CLOSED
;
480 int gdb_put_packet(struct connection
*connection
, char *buffer
, int len
)
482 struct gdb_connection
*gdb_con
= connection
->priv
;
484 int retval
= gdb_put_packet_inner(connection
, buffer
, len
);
487 /* we sent some data, reset timer for keep alive messages */
493 static __inline__
int fetch_packet(struct connection
*connection
, int *checksum_ok
, int noack
, int *len
, char *buffer
)
495 unsigned char my_checksum
= 0;
498 int retval
= ERROR_OK
;
500 struct gdb_connection
*gdb_con
= connection
->priv
;
505 /* move this over into local variables to use registers and give the
506 * more freedom to optimize */
507 char *buf_p
= gdb_con
->buf_p
;
508 int buf_cnt
= gdb_con
->buf_cnt
;
512 /* The common case is that we have an entire packet with no escape chars.
513 * We need to leave at least 2 bytes in the buffer to have
514 * gdb_get_char() update various bits and bobs correctly.
516 if ((buf_cnt
> 2) && ((buf_cnt
+ count
) < *len
))
518 /* The compiler will struggle a bit with constant propagation and
519 * aliasing, so we help it by showing that these values do not
520 * change inside the loop
524 int run
= buf_cnt
- 2;
531 if (character
== '#')
533 /* Danger! character can be '#' when esc is
534 * used so we need an explicit boolean for done here.
540 if (character
== '}')
542 /* data transmitted in binary mode (X packet)
543 * uses 0x7d as escape character */
544 my_checksum
+= character
& 0xff;
547 my_checksum
+= character
& 0xff;
548 buffer
[count
++] = (character
^ 0x20) & 0xff;
552 my_checksum
+= character
& 0xff;
553 buffer
[count
++] = character
& 0xff;
563 LOG_ERROR("packet buffer too small");
564 retval
= ERROR_GDB_BUFFER_TOO_SMALL
;
568 retval
= gdb_get_char_fast(connection
, &character
, &buf_p
, &buf_cnt
);
569 if (retval
!= ERROR_OK
)
572 if (character
== '#')
575 if (character
== '}')
577 /* data transmitted in binary mode (X packet)
578 * uses 0x7d as escape character */
579 my_checksum
+= character
& 0xff;
581 retval
= gdb_get_char_fast(connection
, &character
, &buf_p
, &buf_cnt
);
582 if (retval
!= ERROR_OK
)
585 my_checksum
+= character
& 0xff;
586 buffer
[count
++] = (character
^ 0x20) & 0xff;
590 my_checksum
+= character
& 0xff;
591 buffer
[count
++] = character
& 0xff;
595 gdb_con
->buf_p
= buf_p
;
596 gdb_con
->buf_cnt
= buf_cnt
;
598 if (retval
!= ERROR_OK
)
603 if ((retval
= gdb_get_char(connection
, &character
)) != ERROR_OK
)
605 checksum
[0] = character
;
606 if ((retval
= gdb_get_char(connection
, &character
)) != ERROR_OK
)
608 checksum
[1] = character
;
613 *checksum_ok
= (my_checksum
== strtoul(checksum
, NULL
, 16));
619 int gdb_get_packet_inner(struct connection
*connection
, char *buffer
, int *len
)
623 struct gdb_connection
*gdb_con
= connection
->priv
;
629 if ((retval
= gdb_get_char(connection
, &character
)) != ERROR_OK
)
632 #ifdef _DEBUG_GDB_IO_
633 LOG_DEBUG("character: '%c'", character
);
641 /* gdb sends a dummy ack '+' at every remote connect - see remote_start_remote (remote.c)
642 * in case anyone tries to debug why they receive this warning every time */
643 LOG_WARNING("acknowledgment received, but no packet pending");
646 LOG_WARNING("negative acknowledgment, but no packet pending");
653 LOG_WARNING("ignoring character 0x%x", character
);
656 } while (character
!= '$');
661 /* explicit code expansion here to get faster inlined code in -O3 by not
662 * calculating checksum
664 if (gdb_con
->noack_mode
)
666 if ((retval
= fetch_packet(connection
, &checksum_ok
, 1, len
, buffer
)) != ERROR_OK
)
670 if ((retval
= fetch_packet(connection
, &checksum_ok
, 0, len
, buffer
)) != ERROR_OK
)
674 if (gdb_con
->noack_mode
)
676 /* checksum is not checked in noack mode */
681 if ((retval
= gdb_write(connection
, "+", 1)) != ERROR_OK
)
689 return ERROR_SERVER_REMOTE_CLOSED
;
694 int gdb_get_packet(struct connection
*connection
, char *buffer
, int *len
)
696 struct gdb_connection
*gdb_con
= connection
->priv
;
698 int retval
= gdb_get_packet_inner(connection
, buffer
, len
);
703 int gdb_output_con(struct connection
*connection
, const char* line
)
708 bin_size
= strlen(line
);
710 hex_buffer
= malloc(bin_size
*2 + 2);
711 if (hex_buffer
== NULL
)
712 return ERROR_GDB_BUFFER_TOO_SMALL
;
715 for (i
= 0; i
< bin_size
; i
++)
716 snprintf(hex_buffer
+ 1 + i
*2, 3, "%2.2x", line
[i
]);
717 hex_buffer
[bin_size
*2 + 1] = 0;
719 int retval
= gdb_put_packet(connection
, hex_buffer
, bin_size
*2 + 1);
725 int gdb_output(struct command_context
*context
, const char* line
)
727 /* this will be dumped to the log and also sent as an O packet if possible */
728 LOG_USER_N("%s", line
);
733 static void gdb_frontend_halted(struct target
*target
, struct connection
*connection
)
735 struct gdb_connection
*gdb_connection
= connection
->priv
;
737 /* In the GDB protocol when we are stepping or continuing execution,
738 * we have a lingering reply. Upon receiving a halted event
739 * when we have that lingering packet, we reply to the original
740 * step or continue packet.
742 * Executing monitor commands can bring the target in and
743 * out of the running state so we'll see lots of TARGET_EVENT_XXX
744 * that are to be ignored.
746 if (gdb_connection
->frontend_state
== TARGET_RUNNING
)
751 /* stop forwarding log packets! */
752 log_remove_callback(gdb_log_callback
, connection
);
754 if (gdb_connection
->ctrl_c
)
757 gdb_connection
->ctrl_c
= 0;
761 signal
= gdb_last_signal(target
);
764 snprintf(sig_reply
, 4, "T%2.2x", signal
);
765 gdb_put_packet(connection
, sig_reply
, 3);
766 gdb_connection
->frontend_state
= TARGET_HALTED
;
770 int gdb_target_callback_event_handler(struct target
*target
, enum target_event event
, void *priv
)
773 struct connection
*connection
= priv
;
775 target_handle_event(target
, event
);
778 case TARGET_EVENT_GDB_HALT
:
779 gdb_frontend_halted(target
, connection
);
781 case TARGET_EVENT_HALTED
:
782 target_call_event_callbacks(target
, TARGET_EVENT_GDB_END
);
784 case TARGET_EVENT_GDB_FLASH_ERASE_START
:
785 target_handle_event(target
, TARGET_EVENT_OLD_gdb_program_config
);
786 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
798 int gdb_new_connection(struct connection
*connection
)
800 struct gdb_connection
*gdb_connection
= malloc(sizeof(struct gdb_connection
));
801 struct gdb_service
*gdb_service
= connection
->service
->priv
;
805 connection
->priv
= gdb_connection
;
807 /* initialize gdb connection information */
808 gdb_connection
->buf_p
= gdb_connection
->buffer
;
809 gdb_connection
->buf_cnt
= 0;
810 gdb_connection
->ctrl_c
= 0;
811 gdb_connection
->frontend_state
= TARGET_HALTED
;
812 gdb_connection
->vflash_image
= NULL
;
813 gdb_connection
->closed
= 0;
814 gdb_connection
->busy
= 0;
815 gdb_connection
->noack_mode
= 0;
816 gdb_connection
->sync
= true;
818 /* send ACK to GDB for debug request */
819 gdb_write(connection
, "+", 1);
821 /* output goes through gdb connection */
822 command_set_output_handler(connection
->cmd_ctx
, gdb_output
, connection
);
824 /* we must remove all breakpoints registered to the target as a previous
825 * GDB session could leave dangling breakpoints if e.g. communication
828 breakpoint_clear_target(gdb_service
->target
);
829 watchpoint_clear_target(gdb_service
->target
);
831 /* register callback to be informed about target events */
832 target_register_event_callback(gdb_target_callback_event_handler
, connection
);
834 /* remove the initial ACK from the incoming buffer */
835 if ((retval
= gdb_get_char(connection
, &initial_ack
)) != ERROR_OK
)
838 /* FIX!!!??? would we actually ever receive a + here???
841 if (initial_ack
!= '+')
842 gdb_putback_char(connection
, initial_ack
);
843 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_ATTACH
);
845 gdb_actual_connections
++;
846 LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s",
847 gdb_actual_connections
,
848 target_name(gdb_service
->target
),
849 target_state_name(gdb_service
->target
));
854 int gdb_connection_closed(struct connection
*connection
)
856 struct gdb_service
*gdb_service
= connection
->service
->priv
;
857 struct gdb_connection
*gdb_connection
= connection
->priv
;
859 /* we're done forwarding messages. Tear down callback before
860 * cleaning up connection.
862 log_remove_callback(gdb_log_callback
, connection
);
864 gdb_actual_connections
--;
865 LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
866 target_name(gdb_service
->target
),
867 target_state_name(gdb_service
->target
),
868 gdb_actual_connections
);
870 /* see if an image built with vFlash commands is left */
871 if (gdb_connection
->vflash_image
)
873 image_close(gdb_connection
->vflash_image
);
874 free(gdb_connection
->vflash_image
);
875 gdb_connection
->vflash_image
= NULL
;
878 /* if this connection registered a debug-message receiver delete it */
879 delete_debug_msg_receiver(connection
->cmd_ctx
, gdb_service
->target
);
881 if (connection
->priv
)
883 free(connection
->priv
);
884 connection
->priv
= NULL
;
888 LOG_ERROR("BUG: connection->priv == NULL");
892 target_unregister_event_callback(gdb_target_callback_event_handler
, connection
);
894 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_END
);
896 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_DETACH
);
901 void gdb_send_error(struct connection
*connection
, uint8_t the_error
)
904 snprintf(err
, 4, "E%2.2X", the_error
);
905 gdb_put_packet(connection
, err
, 3);
908 int gdb_last_signal_packet(struct connection
*connection
, struct target
*target
, char* packet
, int packet_size
)
913 signal
= gdb_last_signal(target
);
915 snprintf(sig_reply
, 4, "S%2.2x", signal
);
916 gdb_put_packet(connection
, sig_reply
, 3);
921 static int gdb_reg_pos(struct target
*target
, int pos
, int len
)
923 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
926 return len
- 1 - pos
;
929 /* Convert register to string of bytes. NB! The # of bits in the
930 * register might be non-divisible by 8(a byte), in which
931 * case an entire byte is shown.
933 * NB! the format on the wire is the target endianness
935 * The format of reg->value is little endian
938 void gdb_str_to_target(struct target
*target
, char *tstr
, struct reg
*reg
)
945 buf_len
= DIV_ROUND_UP(reg
->size
, 8);
947 for (i
= 0; i
< buf_len
; i
++)
949 int j
= gdb_reg_pos(target
, i
, buf_len
);
950 tstr
[i
*2] = DIGITS
[(buf
[j
]>>4) & 0xf];
951 tstr
[i
*2 + 1] = DIGITS
[buf
[j
]&0xf];
955 static int hextoint(int c
)
966 LOG_ERROR("BUG: invalid register value %08x", c
);
970 /* copy over in register buffer */
971 void gdb_target_to_reg(struct target
*target
, char *tstr
, int str_len
, uint8_t *bin
)
975 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
980 for (i
= 0; i
< str_len
; i
+= 2)
982 uint8_t t
= hextoint(tstr
[i
]) << 4;
983 t
|= hextoint(tstr
[i
+ 1]);
985 int j
= gdb_reg_pos(target
, i
/2, str_len
/2);
990 int gdb_get_registers_packet(struct connection
*connection
, struct target
*target
, char* packet
, int packet_size
)
992 struct reg
**reg_list
;
995 int reg_packet_size
= 0;
1000 #ifdef _DEBUG_GDB_IO_
1004 if ((retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
)) != ERROR_OK
)
1006 return gdb_error(connection
, retval
);
1009 for (i
= 0; i
< reg_list_size
; i
++)
1011 reg_packet_size
+= reg_list
[i
]->size
;
1014 reg_packet
= malloc(DIV_ROUND_UP(reg_packet_size
, 8) * 2);
1015 reg_packet_p
= reg_packet
;
1017 for (i
= 0; i
< reg_list_size
; i
++)
1019 gdb_str_to_target(target
, reg_packet_p
, reg_list
[i
]);
1020 reg_packet_p
+= DIV_ROUND_UP(reg_list
[i
]->size
, 8) * 2;
1023 #ifdef _DEBUG_GDB_IO_
1026 reg_packet_p
= strndup(reg_packet
, DIV_ROUND_UP(reg_packet_size
, 8) * 2);
1027 LOG_DEBUG("reg_packet: %s", reg_packet_p
);
1032 gdb_put_packet(connection
, reg_packet
, DIV_ROUND_UP(reg_packet_size
, 8) * 2);
1040 int gdb_set_registers_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1043 struct reg
**reg_list
;
1048 #ifdef _DEBUG_GDB_IO_
1052 /* skip command character */
1056 if (packet_size
% 2)
1058 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
1059 return ERROR_SERVER_REMOTE_CLOSED
;
1062 if ((retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
)) != ERROR_OK
)
1064 return gdb_error(connection
, retval
);
1068 for (i
= 0; i
< reg_list_size
; i
++)
1071 int chars
= (DIV_ROUND_UP(reg_list
[i
]->size
, 8) * 2);
1073 if (packet_p
+ chars
> packet
+ packet_size
)
1075 LOG_ERROR("BUG: register packet is too small for registers");
1078 bin_buf
= malloc(DIV_ROUND_UP(reg_list
[i
]->size
, 8));
1079 gdb_target_to_reg(target
, packet_p
, chars
, bin_buf
);
1081 reg_list
[i
]->type
->set(reg_list
[i
], bin_buf
);
1083 /* advance packet pointer */
1090 /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1093 gdb_put_packet(connection
, "OK", 2);
1098 int gdb_get_register_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1101 int reg_num
= strtoul(packet
+ 1, NULL
, 16);
1102 struct reg
**reg_list
;
1106 #ifdef _DEBUG_GDB_IO_
1110 if ((retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
)) != ERROR_OK
)
1112 return gdb_error(connection
, retval
);
1115 if (reg_list_size
<= reg_num
)
1117 LOG_ERROR("gdb requested a non-existing register");
1121 reg_packet
= malloc(DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2);
1123 gdb_str_to_target(target
, reg_packet
, reg_list
[reg_num
]);
1125 gdb_put_packet(connection
, reg_packet
, DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2);
1133 int gdb_set_register_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1137 int reg_num
= strtoul(packet
+ 1, &separator
, 16);
1138 struct reg
**reg_list
;
1144 if ((retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
)) != ERROR_OK
)
1146 return gdb_error(connection
, retval
);
1149 if (reg_list_size
< reg_num
)
1151 LOG_ERROR("gdb requested a non-existing register");
1152 return ERROR_SERVER_REMOTE_CLOSED
;
1155 if (*separator
!= '=')
1157 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1158 return ERROR_SERVER_REMOTE_CLOSED
;
1161 /* convert from GDB-string (target-endian) to hex-string (big-endian) */
1162 bin_buf
= malloc(DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8));
1163 int chars
= (DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2);
1165 /* fix!!! add some sanity checks on packet size here */
1167 gdb_target_to_reg(target
, separator
+ 1, chars
, bin_buf
);
1169 reg_list
[reg_num
]->type
->set(reg_list
[reg_num
], bin_buf
);
1171 gdb_put_packet(connection
, "OK", 2);
1179 int gdb_error(struct connection
*connection
, int retval
)
1183 case ERROR_TARGET_DATA_ABORT
:
1184 gdb_send_error(connection
, EIO
);
1186 case ERROR_TARGET_TRANSLATION_FAULT
:
1187 gdb_send_error(connection
, EFAULT
);
1189 case ERROR_TARGET_UNALIGNED_ACCESS
:
1190 gdb_send_error(connection
, EFAULT
);
1192 case ERROR_TARGET_NOT_HALTED
:
1193 gdb_send_error(connection
, EFAULT
);
1196 /* This could be that the target reset itself. */
1197 LOG_ERROR("unexpected error %i", retval
);
1198 gdb_send_error(connection
, EFAULT
);
1205 /* We don't have to worry about the default 2 second timeout for GDB packets,
1206 * because GDB breaks up large memory reads into smaller reads.
1208 * 8191 bytes by the looks of it. Why 8191 bytes instead of 8192?????
1210 int gdb_read_memory_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1219 int retval
= ERROR_OK
;
1221 /* skip command character */
1224 addr
= strtoul(packet
, &separator
, 16);
1226 if (*separator
!= ',')
1228 LOG_ERROR("incomplete read memory packet received, dropping connection");
1229 return ERROR_SERVER_REMOTE_CLOSED
;
1232 len
= strtoul(separator
+ 1, NULL
, 16);
1234 buffer
= malloc(len
);
1236 LOG_DEBUG("addr: 0x%8.8" PRIx32
", len: 0x%8.8" PRIx32
"", addr
, len
);
1238 retval
= target_read_buffer(target
, addr
, len
, buffer
);
1240 if ((retval
!= ERROR_OK
)&&!gdb_report_data_abort
)
1242 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1243 * At some point this might be fixed in GDB, in which case this code can be removed.
1245 * OpenOCD developers are acutely aware of this problem, but there is nothing
1246 * gained by involving the user in this problem that hopefully will get resolved
1249 * http://sourceware.org/cgi-bin/gnatsweb.pl?cmd = view%20audit-trail&database = gdb&pr = 2395
1251 * For now, the default is to fix up things to make current GDB versions work.
1252 * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1254 memset(buffer
, 0, len
);
1258 if (retval
== ERROR_OK
)
1260 hex_buffer
= malloc(len
* 2 + 1);
1263 for (i
= 0; i
< len
; i
++)
1265 uint8_t t
= buffer
[i
];
1266 hex_buffer
[2 * i
] = DIGITS
[(t
>> 4) & 0xf];
1267 hex_buffer
[2 * i
+ 1] = DIGITS
[t
& 0xf];
1270 gdb_put_packet(connection
, hex_buffer
, len
* 2);
1276 retval
= gdb_error(connection
, retval
);
1284 int gdb_write_memory_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1295 /* skip command character */
1298 addr
= strtoul(packet
, &separator
, 16);
1300 if (*separator
!= ',')
1302 LOG_ERROR("incomplete write memory packet received, dropping connection");
1303 return ERROR_SERVER_REMOTE_CLOSED
;
1306 len
= strtoul(separator
+ 1, &separator
, 16);
1308 if (*(separator
++) != ':')
1310 LOG_ERROR("incomplete write memory packet received, dropping connection");
1311 return ERROR_SERVER_REMOTE_CLOSED
;
1314 buffer
= malloc(len
);
1316 LOG_DEBUG("addr: 0x%8.8" PRIx32
", len: 0x%8.8" PRIx32
"", addr
, len
);
1318 for (i
= 0; i
< len
; i
++)
1321 sscanf(separator
+ 2*i
, "%2" SCNx32
, &tmp
);
1325 retval
= target_write_buffer(target
, addr
, len
, buffer
);
1327 if (retval
== ERROR_OK
)
1329 gdb_put_packet(connection
, "OK", 2);
1333 retval
= gdb_error(connection
, retval
);
1341 int gdb_write_memory_binary_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1349 /* skip command character */
1352 addr
= strtoul(packet
, &separator
, 16);
1354 if (*separator
!= ',')
1356 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1357 return ERROR_SERVER_REMOTE_CLOSED
;
1360 len
= strtoul(separator
+ 1, &separator
, 16);
1362 if (*(separator
++) != ':')
1364 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1365 return ERROR_SERVER_REMOTE_CLOSED
;
1371 LOG_DEBUG("addr: 0x%8.8" PRIx32
", len: 0x%8.8" PRIx32
"", addr
, len
);
1373 retval
= target_write_buffer(target
, addr
, len
, (uint8_t*)separator
);
1376 if (retval
== ERROR_OK
)
1378 gdb_put_packet(connection
, "OK", 2);
1382 if ((retval
= gdb_error(connection
, retval
)) != ERROR_OK
)
1389 int gdb_step_continue_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1392 uint32_t address
= 0x0;
1393 int retval
= ERROR_OK
;
1397 if (packet_size
> 1)
1399 packet
[packet_size
] = 0;
1400 address
= strtoul(packet
+ 1, NULL
, 16);
1407 if (packet
[0] == 'c')
1409 LOG_DEBUG("continue");
1410 target_handle_event(target
, TARGET_EVENT_OLD_pre_resume
);
1411 retval
= target_resume(target
, current
, address
, 0, 0); /* resume at current address, don't handle breakpoints, not debugging */
1413 else if (packet
[0] == 's')
1416 /* step at current or address, don't handle breakpoints */
1417 retval
= target_step(target
, current
, address
, 0);
1422 int gdb_breakpoint_watchpoint_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1425 enum breakpoint_type bp_type
= BKPT_SOFT
/* dummy init to avoid warning */;
1426 enum watchpoint_rw wp_type
= WPT_READ
/* dummy init to avoid warning */;
1434 type
= strtoul(packet
+ 1, &separator
, 16);
1436 if (type
== 0) /* memory breakpoint */
1437 bp_type
= BKPT_SOFT
;
1438 else if (type
== 1) /* hardware breakpoint */
1439 bp_type
= BKPT_HARD
;
1440 else if (type
== 2) /* write watchpoint */
1441 wp_type
= WPT_WRITE
;
1442 else if (type
== 3) /* read watchpoint */
1444 else if (type
== 4) /* access watchpoint */
1445 wp_type
= WPT_ACCESS
;
1448 LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type
);
1449 return ERROR_SERVER_REMOTE_CLOSED
;
1453 if (gdb_breakpoint_override
&& ((bp_type
== BKPT_SOFT
)||(bp_type
== BKPT_HARD
)))
1455 bp_type
= gdb_breakpoint_override_type
;
1458 if (*separator
!= ',')
1460 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1461 return ERROR_SERVER_REMOTE_CLOSED
;
1464 address
= strtoul(separator
+ 1, &separator
, 16);
1466 if (*separator
!= ',')
1468 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1469 return ERROR_SERVER_REMOTE_CLOSED
;
1472 size
= strtoul(separator
+ 1, &separator
, 16);
1478 if (packet
[0] == 'Z')
1480 if ((retval
= breakpoint_add(target
, address
, size
, bp_type
)) != ERROR_OK
)
1482 if ((retval
= gdb_error(connection
, retval
)) != ERROR_OK
)
1487 gdb_put_packet(connection
, "OK", 2);
1492 breakpoint_remove(target
, address
);
1493 gdb_put_packet(connection
, "OK", 2);
1500 if (packet
[0] == 'Z')
1502 if ((retval
= watchpoint_add(target
, address
, size
, wp_type
, 0, 0xffffffffu
)) != ERROR_OK
)
1504 if ((retval
= gdb_error(connection
, retval
)) != ERROR_OK
)
1509 gdb_put_packet(connection
, "OK", 2);
1514 watchpoint_remove(target
, address
);
1515 gdb_put_packet(connection
, "OK", 2);
1526 /* print out a string and allocate more space as needed, mainly used for XML at this point */
1527 void xml_printf(int *retval
, char **xml
, int *pos
, int *size
, const char *fmt
, ...)
1529 if (*retval
!= ERROR_OK
)
1537 if ((*xml
== NULL
) || (!first
))
1539 /* start by 0 to exercise all the code paths.
1540 * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1542 *size
= *size
* 2 + 2;
1544 *xml
= realloc(*xml
, *size
);
1549 *retval
= ERROR_SERVER_REMOTE_CLOSED
;
1557 ret
= vsnprintf(*xml
+ *pos
, *size
- *pos
, fmt
, ap
);
1559 if ((ret
> 0) && ((ret
+ 1) < *size
- *pos
))
1564 /* there was just enough or not enough space, allocate more. */
1569 static int decode_xfer_read(char *buf
, char **annex
, int *ofs
, unsigned int *len
)
1573 /* Extract and NUL-terminate the annex. */
1575 while (*buf
&& *buf
!= ':')
1581 /* After the read marker and annex, qXfer looks like a
1582 * traditional 'm' packet. */
1584 *ofs
= strtoul(buf
, &separator
, 16);
1586 if (*separator
!= ',')
1589 *len
= strtoul(separator
+ 1, NULL
, 16);
1594 int gdb_calc_blocksize(struct flash_bank
*bank
)
1597 uint32_t block_size
= 0xffffffff;
1599 /* loop through all sectors and return smallest sector size */
1601 for (i
= 0; i
< (uint32_t)bank
->num_sectors
; i
++)
1603 if (bank
->sectors
[i
].size
< block_size
)
1604 block_size
= bank
->sectors
[i
].size
;
1610 static int compare_bank (const void * a
, const void * b
)
1612 struct flash_bank
*b1
, *b2
;
1613 b1
=*((struct flash_bank
**)a
);
1614 b2
=*((struct flash_bank
**)b
);
1616 if (b1
->base
== b2
->base
)
1619 } else if (b1
->base
> b2
->base
)
1628 int gdb_query_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1630 struct command_context
*cmd_ctx
= connection
->cmd_ctx
;
1631 struct gdb_connection
*gdb_connection
= connection
->priv
;
1633 if (strstr(packet
, "qRcmd,"))
1635 if (packet_size
> 6)
1639 cmd
= malloc((packet_size
- 6)/2 + 1);
1640 for (i
= 0; i
< (packet_size
- 6)/2; i
++)
1643 sscanf(packet
+ 6 + 2*i
, "%2" SCNx32
, &tmp
);
1646 cmd
[(packet_size
- 6)/2] = 0x0;
1648 /* We want to print all debug output to GDB connection */
1649 log_add_callback(gdb_log_callback
, connection
);
1650 target_call_timer_callbacks_now();
1651 /* some commands need to know the GDB connection, make note of current
1652 * GDB connection. */
1653 current_gdb_connection
= gdb_connection
;
1654 command_run_line(cmd_ctx
, cmd
);
1655 current_gdb_connection
= NULL
;
1656 target_call_timer_callbacks_now();
1657 log_remove_callback(gdb_log_callback
, connection
);
1660 gdb_put_packet(connection
, "OK", 2);
1663 else if (strstr(packet
, "qCRC:"))
1665 if (packet_size
> 5)
1674 /* skip command character */
1677 addr
= strtoul(packet
, &separator
, 16);
1679 if (*separator
!= ',')
1681 LOG_ERROR("incomplete read memory packet received, dropping connection");
1682 return ERROR_SERVER_REMOTE_CLOSED
;
1685 len
= strtoul(separator
+ 1, NULL
, 16);
1687 retval
= target_checksum_memory(target
, addr
, len
, &checksum
);
1689 if (retval
== ERROR_OK
)
1691 snprintf(gdb_reply
, 10, "C%8.8" PRIx32
"", checksum
);
1692 gdb_put_packet(connection
, gdb_reply
, 9);
1696 if ((retval
= gdb_error(connection
, retval
)) != ERROR_OK
)
1703 else if (strstr(packet
, "qSupported"))
1705 /* we currently support packet size and qXfer:memory-map:read (if enabled)
1706 * disable qXfer:features:read for the moment */
1707 int retval
= ERROR_OK
;
1708 char *buffer
= NULL
;
1712 xml_printf(&retval
, &buffer
, &pos
, &size
,
1713 "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read-;QStartNoAckMode+",
1714 (GDB_BUFFER_SIZE
- 1), ((gdb_use_memory_map
== 1) && (flash_get_bank_count() > 0)) ? '+' : '-');
1716 if (retval
!= ERROR_OK
)
1718 gdb_send_error(connection
, 01);
1722 gdb_put_packet(connection
, buffer
, strlen(buffer
));
1727 else if (strstr(packet
, "qXfer:memory-map:read::") && (flash_get_bank_count() > 0))
1729 /* We get away with only specifying flash here. Regions that are not
1730 * specified are treated as if we provided no memory map(if not we
1731 * could detect the holes and mark them as RAM).
1732 * Normally we only execute this code once, but no big deal if we
1733 * have to regenerate it a couple of times. */
1735 struct flash_bank
*p
;
1739 int retval
= ERROR_OK
;
1746 /* skip command character */
1749 offset
= strtoul(packet
, &separator
, 16);
1750 length
= strtoul(separator
+ 1, &separator
, 16);
1752 xml_printf(&retval
, &xml
, &pos
, &size
, "<memory-map>\n");
1755 sort banks in ascending order, we need to make non-flash memory be ram(or rather
1756 read/write) by default for GDB.
1757 GDB does not have a concept of non-cacheable read/write memory.
1759 struct flash_bank
**banks
= malloc(sizeof(struct flash_bank
*)*flash_get_bank_count());
1762 for (i
= 0; i
< flash_get_bank_count(); i
++)
1764 p
= get_flash_bank_by_num(i
);
1768 retval
= ERROR_FAIL
;
1769 gdb_send_error(connection
, retval
);
1775 qsort(banks
, flash_get_bank_count(), sizeof(struct flash_bank
*), compare_bank
);
1777 uint32_t ram_start
= 0;
1778 for (i
= 0; i
< flash_get_bank_count(); i
++)
1782 if (ram_start
< p
->base
)
1784 xml_printf(&retval
, &xml
, &pos
, &size
, "<memory type=\"ram\" start=\"0x%x\" length=\"0x%x\"/>\n",
1785 ram_start
, p
->base
-ram_start
);
1788 /* if device has uneven sector sizes, eg. str7, lpc
1789 * we pass the smallest sector size to gdb memory map */
1790 blocksize
= gdb_calc_blocksize(p
);
1792 xml_printf(&retval
, &xml
, &pos
, &size
, "<memory type=\"flash\" start=\"0x%x\" length=\"0x%x\">\n" \
1793 "<property name=\"blocksize\">0x%x</property>\n" \
1795 p
->base
, p
->size
, blocksize
);
1796 ram_start
= p
->base
+ p
->size
;
1800 xml_printf(&retval
, &xml
, &pos
, &size
, "<memory type=\"ram\" start=\"0x%x\" length=\"0x%x\"/>\n",
1801 ram_start
, 0-ram_start
);
1804 /* a flash chip could be at the very end of the 32 bit address space, in which case
1805 ram_start will be precisely 0 */
1811 xml_printf(&retval
, &xml
, &pos
, &size
, "</memory-map>\n");
1813 if (retval
!= ERROR_OK
)
1815 gdb_send_error(connection
, retval
);
1819 if (offset
+ length
> pos
)
1821 length
= pos
- offset
;
1824 char *t
= malloc(length
+ 1);
1826 memcpy(t
+ 1, xml
+ offset
, length
);
1827 gdb_put_packet(connection
, t
, length
+ 1);
1833 else if (strstr(packet
, "qXfer:features:read:"))
1838 int retval
= ERROR_OK
;
1841 unsigned int length
;
1844 /* skip command character */
1847 if (decode_xfer_read(packet
, &annex
, &offset
, &length
) < 0)
1849 gdb_send_error(connection
, 01);
1853 if (strcmp(annex
, "target.xml") != 0)
1855 gdb_send_error(connection
, 01);
1859 xml_printf(&retval
, &xml
, &pos
, &size
, \
1860 "l < target version=\"1.0\">\n < architecture > arm</architecture>\n</target>\n");
1862 if (retval
!= ERROR_OK
)
1864 gdb_send_error(connection
, retval
);
1868 gdb_put_packet(connection
, xml
, strlen(xml
));
1873 else if (strstr(packet
, "QStartNoAckMode"))
1875 gdb_connection
->noack_mode
= 1;
1876 gdb_put_packet(connection
, "OK", 2);
1880 gdb_put_packet(connection
, "", 0);
1884 int gdb_v_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1886 struct gdb_connection
*gdb_connection
= connection
->priv
;
1887 struct gdb_service
*gdb_service
= connection
->service
->priv
;
1890 /* if flash programming disabled - send a empty reply */
1892 if (gdb_flash_program
== 0)
1894 gdb_put_packet(connection
, "", 0);
1898 if (strstr(packet
, "vFlashErase:"))
1901 unsigned long length
;
1903 char *parse
= packet
+ 12;
1906 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1907 return ERROR_SERVER_REMOTE_CLOSED
;
1910 addr
= strtoul(parse
, &parse
, 16);
1912 if (*(parse
++) != ',' || *parse
== '\0')
1914 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1915 return ERROR_SERVER_REMOTE_CLOSED
;
1918 length
= strtoul(parse
, &parse
, 16);
1922 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1923 return ERROR_SERVER_REMOTE_CLOSED
;
1926 /* assume all sectors need erasing - stops any problems
1927 * when flash_write is called multiple times */
1930 /* perform any target specific operations before the erase */
1931 target_call_event_callbacks(gdb_service
->target
,
1932 TARGET_EVENT_GDB_FLASH_ERASE_START
);
1934 /* vFlashErase:addr,length messages require region start and
1935 * end to be "block" aligned ... if padding is ever needed,
1936 * GDB will have become dangerously confused.
1938 result
= flash_erase_address_range(gdb_service
->target
,
1939 false, addr
, length
);
1941 /* perform any target specific operations after the erase */
1942 target_call_event_callbacks(gdb_service
->target
,
1943 TARGET_EVENT_GDB_FLASH_ERASE_END
);
1946 if (result
!= ERROR_OK
)
1948 /* GDB doesn't evaluate the actual error number returned,
1949 * treat a failed erase as an I/O error
1951 gdb_send_error(connection
, EIO
);
1952 LOG_ERROR("flash_erase returned %i", result
);
1955 gdb_put_packet(connection
, "OK", 2);
1960 if (strstr(packet
, "vFlashWrite:"))
1964 unsigned long length
;
1965 char *parse
= packet
+ 12;
1969 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1970 return ERROR_SERVER_REMOTE_CLOSED
;
1972 addr
= strtoul(parse
, &parse
, 16);
1973 if (*(parse
++) != ':')
1975 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1976 return ERROR_SERVER_REMOTE_CLOSED
;
1978 length
= packet_size
- (parse
- packet
);
1980 /* create a new image if there isn't already one */
1981 if (gdb_connection
->vflash_image
== NULL
)
1983 gdb_connection
->vflash_image
= malloc(sizeof(struct image
));
1984 image_open(gdb_connection
->vflash_image
, "", "build");
1987 /* create new section with content from packet buffer */
1988 if ((retval
= image_add_section(gdb_connection
->vflash_image
, addr
, length
, 0x0, (uint8_t*)parse
)) != ERROR_OK
)
1993 gdb_put_packet(connection
, "OK", 2);
1998 if (!strcmp(packet
, "vFlashDone"))
2002 /* process the flashing buffer. No need to erase as GDB
2003 * always issues a vFlashErase first. */
2004 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_FLASH_WRITE_START
);
2005 result
= flash_write(gdb_service
->target
, gdb_connection
->vflash_image
, &written
, 0);
2006 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_FLASH_WRITE_END
);
2007 if (result
!= ERROR_OK
)
2009 if (result
== ERROR_FLASH_DST_OUT_OF_BANK
)
2010 gdb_put_packet(connection
, "E.memtype", 9);
2012 gdb_send_error(connection
, EIO
);
2016 LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written
);
2017 gdb_put_packet(connection
, "OK", 2);
2020 image_close(gdb_connection
->vflash_image
);
2021 free(gdb_connection
->vflash_image
);
2022 gdb_connection
->vflash_image
= NULL
;
2027 gdb_put_packet(connection
, "", 0);
2031 int gdb_detach(struct connection
*connection
, struct target
*target
)
2033 struct gdb_service
*gdb_service
= connection
->service
->priv
;
2035 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_DETACH
);
2037 return gdb_put_packet(connection
, "OK", 2);
2040 static void gdb_log_callback(void *priv
, const char *file
, unsigned line
,
2041 const char *function
, const char *string
)
2043 struct connection
*connection
= priv
;
2044 struct gdb_connection
*gdb_con
= connection
->priv
;
2048 /* do not reply this using the O packet */
2052 gdb_output_con(connection
, string
);
2055 /* Do not allocate this on the stack */
2056 char gdb_packet_buffer
[GDB_BUFFER_SIZE
];
2058 static void gdb_sig_halted(struct connection
*connection
)
2061 snprintf(sig_reply
, 4, "T%2.2x", 2);
2062 gdb_put_packet(connection
, sig_reply
, 3);
2066 int gdb_input_inner(struct connection
*connection
)
2068 struct gdb_service
*gdb_service
= connection
->service
->priv
;
2069 struct target
*target
= gdb_service
->target
;
2070 char *packet
= gdb_packet_buffer
;
2073 struct gdb_connection
*gdb_con
= connection
->priv
;
2074 static int extended_protocol
= 0;
2076 /* drain input buffer */
2079 packet_size
= GDB_BUFFER_SIZE
-1;
2080 if ((retval
= gdb_get_packet(connection
, packet
, &packet_size
)) != ERROR_OK
)
2085 /* terminate with zero */
2086 packet
[packet_size
] = 0;
2088 if (LOG_LEVEL_IS(LOG_LVL_DEBUG
)) {
2089 if (packet
[0] == 'X') {
2090 // binary packets spew junk into the debug log stream
2093 for (x
= 0 ; (x
< 49) && (packet
[x
] != ':') ; x
++) {
2097 LOG_DEBUG("received packet: '%s:<binary-data>'", buf
);
2099 LOG_DEBUG("received packet: '%s'", packet
);
2103 if (packet_size
> 0)
2109 /* Hct... -- set thread
2110 * we don't have threads, send empty reply */
2111 gdb_put_packet(connection
, NULL
, 0);
2115 retval
= gdb_query_packet(connection
, target
, packet
, packet_size
);
2118 retval
= gdb_get_registers_packet(connection
, target
, packet
, packet_size
);
2121 retval
= gdb_set_registers_packet(connection
, target
, packet
, packet_size
);
2124 retval
= gdb_get_register_packet(connection
, target
, packet
, packet_size
);
2127 retval
= gdb_set_register_packet(connection
, target
, packet
, packet_size
);
2130 retval
= gdb_read_memory_packet(connection
, target
, packet
, packet_size
);
2133 retval
= gdb_write_memory_packet(connection
, target
, packet
, packet_size
);
2137 retval
= gdb_breakpoint_watchpoint_packet(connection
, target
, packet
, packet_size
);
2140 gdb_last_signal_packet(connection
, target
, packet
, packet_size
);
2145 int retval
= ERROR_OK
;
2147 struct gdb_connection
*gdb_con
= connection
->priv
;
2148 log_add_callback(gdb_log_callback
, connection
);
2150 bool nostep
= false;
2151 if (target
->state
== TARGET_RUNNING
)
2153 LOG_WARNING("The target is already running. Halt target before stepi/continue.");
2154 retval
= target_halt(target
);
2155 if (retval
== ERROR_OK
)
2156 retval
= target_wait_state(target
, TARGET_HALTED
, 100);
2157 } else if (target
->state
!= TARGET_HALTED
)
2159 LOG_WARNING("The target is not in the halted nor running stated, stepi/continue ignored.");
2161 } else if ((packet
[0] == 's') && gdb_con
->sync
)
2163 /* Hmm..... when you issue a continue in GDB, then a "stepi" is
2164 * sent by GDB first to OpenOCD, thus defeating the check to
2165 * make only the single stepping have the sync feature...
2168 LOG_WARNING("stepi ignored. GDB will now fetch the register state from the target.");
2170 gdb_con
->sync
= false;
2172 if ((retval
!=ERROR_OK
) || nostep
)
2174 /* Either the target isn't in the halted state, then we can't
2175 * step/continue. This might be early setup, etc.
2177 * Or we want to allow GDB to pick up a fresh set of
2178 * register values without modifying the target state.
2181 gdb_sig_halted(connection
);
2183 /* stop forwarding log packets! */
2184 log_remove_callback(gdb_log_callback
, connection
);
2187 /* We're running/stepping, in which case we can
2188 * forward log output until the target is halted
2190 gdb_con
->frontend_state
= TARGET_RUNNING
;
2191 target_call_event_callbacks(target
, TARGET_EVENT_GDB_START
);
2192 int retval
= gdb_step_continue_packet(connection
, target
, packet
, packet_size
);
2193 if (retval
!= ERROR_OK
)
2195 /* we'll never receive a halted condition... issue a false one.. */
2196 gdb_frontend_halted(target
, connection
);
2202 retval
= gdb_v_packet(connection
, target
, packet
, packet_size
);
2205 retval
= gdb_detach(connection
, target
);
2206 extended_protocol
= 0;
2209 if ((retval
= gdb_write_memory_binary_packet(connection
, target
, packet
, packet_size
)) != ERROR_OK
)
2213 if (extended_protocol
!= 0)
2215 gdb_put_packet(connection
, "OK", 2);
2216 return ERROR_SERVER_REMOTE_CLOSED
;
2218 /* handle extended remote protocol */
2219 extended_protocol
= 1;
2220 gdb_put_packet(connection
, "OK", 2);
2223 /* handle extended restart packet */
2224 breakpoint_clear_target(gdb_service
->target
);
2225 watchpoint_clear_target(gdb_service
->target
);
2226 command_run_linef(connection
->cmd_ctx
,
2227 "ocd_gdb_restart %s",
2228 target_name(target
));
2231 /* ignore unknown packets */
2232 LOG_DEBUG("ignoring 0x%2.2x packet", packet
[0]);
2233 gdb_put_packet(connection
, NULL
, 0);
2237 /* if a packet handler returned an error, exit input loop */
2238 if (retval
!= ERROR_OK
)
2242 if (gdb_con
->ctrl_c
)
2244 if (target
->state
== TARGET_RUNNING
)
2246 retval
= target_halt(target
);
2247 if (retval
!= ERROR_OK
)
2249 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
2251 gdb_con
->ctrl_c
= 0;
2254 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
2255 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
2259 } while (gdb_con
->buf_cnt
> 0);
2264 int gdb_input(struct connection
*connection
)
2266 int retval
= gdb_input_inner(connection
);
2267 struct gdb_connection
*gdb_con
= connection
->priv
;
2268 if (retval
== ERROR_SERVER_REMOTE_CLOSED
)
2271 /* logging does not propagate the error, yet can set the gdb_con->closed flag */
2272 if (gdb_con
->closed
)
2273 return ERROR_SERVER_REMOTE_CLOSED
;
2275 /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
2279 static int gdb_target_start(struct target
*target
, uint16_t port
)
2281 bool use_pipes
= 0 == port
;
2282 struct gdb_service
*gdb_service
= malloc(sizeof(struct gdb_service
));
2283 if (NULL
== gdb_service
)
2286 gdb_service
->target
= target
;
2288 add_service("gdb", use_pipes
? CONNECTION_PIPE
: CONNECTION_TCP
,
2289 port
, 1, &gdb_new_connection
, &gdb_input
,
2290 &gdb_connection_closed
, gdb_service
);
2292 const char *name
= target_name(target
);
2294 LOG_DEBUG("gdb service for target '%s' using pipes", name
);
2296 LOG_DEBUG("gdb service for target '%s' on TCP port %u", name
, port
);
2301 int gdb_target_add_one(struct target
*target
)
2303 if (gdb_port
== 0 && server_use_pipes
== 0)
2305 LOG_INFO("gdb port disabled");
2308 if (0 == gdb_port_next
)
2309 gdb_port_next
= gdb_port
;
2311 bool use_pipes
= server_use_pipes
;
2312 static bool server_started_with_pipes
= false;
2313 if (server_started_with_pipes
)
2315 LOG_WARNING("gdb service permits one target when using pipes");
2322 int e
= gdb_target_start(target
, use_pipes
? 0 : gdb_port_next
);
2325 server_started_with_pipes
|= use_pipes
;
2331 int gdb_target_add_all(struct target
*target
)
2335 LOG_WARNING("gdb services need one or more targets defined");
2339 while (NULL
!= target
)
2341 int retval
= gdb_target_add_one(target
);
2342 if (ERROR_OK
!= retval
)
2345 target
= target
->next
;
2351 COMMAND_HANDLER(handle_gdb_sync_command
)
2355 return ERROR_COMMAND_SYNTAX_ERROR
;
2358 if (current_gdb_connection
== NULL
)
2360 command_print(CMD_CTX
,
2361 "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
2365 current_gdb_connection
->sync
= true;
2370 /* daemon configuration command gdb_port */
2371 COMMAND_HANDLER(handle_gdb_port_command
)
2373 int retval
= CALL_COMMAND_HANDLER(server_port_command
, &gdb_port
);
2374 if (ERROR_OK
== retval
)
2375 gdb_port_next
= gdb_port
;
2379 COMMAND_HANDLER(handle_gdb_memory_map_command
)
2382 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_use_memory_map
);
2384 return ERROR_COMMAND_SYNTAX_ERROR
;
2387 COMMAND_HANDLER(handle_gdb_flash_program_command
)
2390 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_flash_program
);
2392 return ERROR_COMMAND_SYNTAX_ERROR
;
2395 COMMAND_HANDLER(handle_gdb_report_data_abort_command
)
2398 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_report_data_abort
);
2400 return ERROR_COMMAND_SYNTAX_ERROR
;
2403 /* gdb_breakpoint_override */
2404 COMMAND_HANDLER(handle_gdb_breakpoint_override_command
)
2409 } else if (CMD_ARGC
== 1)
2411 gdb_breakpoint_override
= 1;
2412 if (strcmp(CMD_ARGV
[0], "hard") == 0)
2414 gdb_breakpoint_override_type
= BKPT_HARD
;
2415 } else if (strcmp(CMD_ARGV
[0], "soft") == 0)
2417 gdb_breakpoint_override_type
= BKPT_SOFT
;
2418 } else if (strcmp(CMD_ARGV
[0], "disable") == 0)
2420 gdb_breakpoint_override
= 0;
2424 return ERROR_COMMAND_SYNTAX_ERROR
;
2426 if (gdb_breakpoint_override
)
2428 LOG_USER("force %s breakpoints", (gdb_breakpoint_override_type
== BKPT_HARD
)?"hard":"soft");
2431 LOG_USER("breakpoint type is not overridden");
2437 static const struct command_registration gdb_command_handlers
[] = {
2440 .handler
= handle_gdb_sync_command
,
2441 .mode
= COMMAND_ANY
,
2442 .help
= "next stepi will return immediately allowing "
2443 "GDB to fetch register state without affecting "
2448 .handler
= handle_gdb_port_command
,
2449 .mode
= COMMAND_ANY
,
2450 .help
= "Display or specify base port on which to listen "
2451 "for incoming GDB connections. "
2452 "No arguments reports GDB port; zero disables.",
2453 .usage
= "[port_num]",
2456 .name
= "gdb_memory_map",
2457 .handler
= handle_gdb_memory_map_command
,
2458 .mode
= COMMAND_CONFIG
,
2459 .help
= "enable or disable memory map",
2460 .usage
= "('enable'|'disable')"
2463 .name
= "gdb_flash_program",
2464 .handler
= handle_gdb_flash_program_command
,
2465 .mode
= COMMAND_CONFIG
,
2466 .help
= "enable or disable flash program",
2467 .usage
= "('enable'|'disable')"
2470 .name
= "gdb_report_data_abort",
2471 .handler
= handle_gdb_report_data_abort_command
,
2472 .mode
= COMMAND_CONFIG
,
2473 .help
= "enable or disable reporting data aborts",
2474 .usage
= "('enable'|'disable')"
2477 .name
= "gdb_breakpoint_override",
2478 .handler
= handle_gdb_breakpoint_override_command
,
2479 .mode
= COMMAND_ANY
,
2480 .help
= "Display or specify type of breakpoint "
2481 "to be used by gdb 'break' commands.",
2482 .usage
= "('hard'|'soft'|'disable')"
2484 COMMAND_REGISTRATION_DONE
2487 int gdb_register_commands(struct command_context
*cmd_ctx
)
2489 return register_commands(cmd_ctx
, NULL
, gdb_command_handlers
);