1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
11 * Copyright (C) 2011 by Broadcom Corporation *
12 * Evan Hunter - ehunter@broadcom.com *
14 * Copyright (C) ST-Ericsson SA 2011 *
15 * michel.jaouen@stericsson.com : smp minimum support *
17 * Copyright (C) 2013 Andes Technology *
18 * Hsiangkai Wang <hkwang@andestech.com> *
20 * Copyright (C) 2013 Franck Jullien *
21 * elec4fun@gmail.com *
23 * This program is free software; you can redistribute it and/or modify *
24 * it under the terms of the GNU General Public License as published by *
25 * the Free Software Foundation; either version 2 of the License, or *
26 * (at your option) any later version. *
28 * This program is distributed in the hope that it will be useful, *
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
31 * GNU General Public License for more details. *
33 * You should have received a copy of the GNU General Public License *
34 * along with this program; if not, write to the *
35 * Free Software Foundation, Inc., *
36 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
37 ***************************************************************************/
43 #include <target/breakpoints.h>
44 #include <target/target_request.h>
45 #include <target/register.h>
47 #include <flash/nor/core.h>
48 #include "gdb_server.h"
49 #include <target/image.h>
50 #include <jtag/jtag.h>
51 #include "rtos/rtos.h"
52 #include "target/smp.h"
56 * GDB server implementation.
58 * This implements the GDB Remote Serial Protocol, over TCP connections,
59 * giving GDB access to the JTAG or other hardware debugging facilities
60 * found in most modern embedded processors.
63 /* private connection data for GDB */
64 struct gdb_connection
{
65 char buffer
[GDB_BUFFER_SIZE
];
69 enum target_state frontend_state
;
70 struct image
*vflash_image
;
74 /* set flag to true if you want the next stepi to return immediately.
75 * allowing GDB to pick up a fresh set of register values from the target
76 * without modifying the target state. */
78 /* We delay reporting memory write errors until next step/continue or memory
79 * write. This improves performance of gdb load significantly as the GDB packet
80 * can be replied immediately and a new GDB packet will be ready without delay
81 * (ca. 10% or so...). */
83 /* with extended-remote it seems we need to better emulate attach/detach.
84 * what this means is we reply with a W stop reply after a kill packet,
85 * normally we reply with a S reply via gdb_last_signal_packet.
86 * as a side note this behaviour only effects gdb > 6.8 */
91 #define _DEBUG_GDB_IO_
94 static struct gdb_connection
*current_gdb_connection
;
96 static int gdb_breakpoint_override
;
97 static enum breakpoint_type gdb_breakpoint_override_type
;
99 static int gdb_error(struct connection
*connection
, int retval
);
100 static const char *gdb_port
;
101 static const char *gdb_port_next
;
103 static void gdb_log_callback(void *priv
, const char *file
, unsigned line
,
104 const char *function
, const char *string
);
106 /* number of gdb connections, mainly to suppress gdb related debugging spam
107 * in helper/log.c when no gdb connections are actually active */
108 int gdb_actual_connections
;
110 /* set if we are sending a memory map to gdb
111 * via qXfer:memory-map:read packet */
112 /* enabled by default*/
113 static int gdb_use_memory_map
= 1;
114 /* enabled by default*/
115 static int gdb_flash_program
= 1;
117 /* if set, data aborts cause an error to be reported in memory read packets
118 * see the code in gdb_read_memory_packet() for further explanations.
119 * Disabled by default.
121 static int gdb_report_data_abort
;
123 /* set if we are sending target descriptions to gdb
124 * via qXfer:features:read packet */
125 /* enabled by default */
126 static int gdb_use_target_description
= 1;
128 /* current processing free-run type, used by file-I/O */
129 static char gdb_running_type
;
131 static int gdb_last_signal(struct target
*target
)
133 switch (target
->debug_reason
) {
134 case DBG_REASON_DBGRQ
:
135 return 0x2; /* SIGINT */
136 case DBG_REASON_BREAKPOINT
:
137 case DBG_REASON_WATCHPOINT
:
138 case DBG_REASON_WPTANDBKPT
:
139 return 0x05; /* SIGTRAP */
140 case DBG_REASON_SINGLESTEP
:
141 return 0x05; /* SIGTRAP */
142 case DBG_REASON_NOTHALTED
:
143 return 0x0; /* no signal... shouldn't happen */
145 LOG_USER("undefined debug reason %d - target needs reset",
146 target
->debug_reason
);
151 static int check_pending(struct connection
*connection
,
152 int timeout_s
, int *got_data
)
154 /* a non-blocking socket will block if there is 0 bytes available on the socket,
155 * but return with as many bytes as are available immediately
159 struct gdb_connection
*gdb_con
= connection
->priv
;
161 if (got_data
== NULL
)
165 if (gdb_con
->buf_cnt
> 0) {
171 FD_SET(connection
->fd
, &read_fds
);
173 tv
.tv_sec
= timeout_s
;
175 if (socket_select(connection
->fd
+ 1, &read_fds
, NULL
, NULL
, &tv
) == 0) {
176 /* This can typically be because a "monitor" command took too long
177 * before printing any progress messages
180 return ERROR_GDB_TIMEOUT
;
184 *got_data
= FD_ISSET(connection
->fd
, &read_fds
) != 0;
188 static int gdb_get_char_inner(struct connection
*connection
, int *next_char
)
190 struct gdb_connection
*gdb_con
= connection
->priv
;
191 int retval
= ERROR_OK
;
193 #ifdef _DEBUG_GDB_IO_
197 if (connection
->service
->type
!= CONNECTION_TCP
)
198 gdb_con
->buf_cnt
= read(connection
->fd
, gdb_con
->buffer
, GDB_BUFFER_SIZE
);
200 retval
= check_pending(connection
, 1, NULL
);
201 if (retval
!= ERROR_OK
)
203 gdb_con
->buf_cnt
= read_socket(connection
->fd
,
208 if (gdb_con
->buf_cnt
> 0)
210 if (gdb_con
->buf_cnt
== 0) {
212 return ERROR_SERVER_REMOTE_CLOSED
;
216 errno
= WSAGetLastError();
222 case WSAECONNABORTED
:
224 return ERROR_SERVER_REMOTE_CLOSED
;
227 return ERROR_SERVER_REMOTE_CLOSED
;
229 LOG_ERROR("read: %d", errno
);
239 return ERROR_SERVER_REMOTE_CLOSED
;
242 return ERROR_SERVER_REMOTE_CLOSED
;
244 LOG_ERROR("read: %s", strerror(errno
));
246 return ERROR_SERVER_REMOTE_CLOSED
;
251 #ifdef _DEBUG_GDB_IO_
252 debug_buffer
= strndup(gdb_con
->buffer
, gdb_con
->buf_cnt
);
253 LOG_DEBUG("received '%s'", debug_buffer
);
257 gdb_con
->buf_p
= gdb_con
->buffer
;
259 *next_char
= *(gdb_con
->buf_p
++);
260 if (gdb_con
->buf_cnt
> 0)
261 connection
->input_pending
= 1;
263 connection
->input_pending
= 0;
264 #ifdef _DEBUG_GDB_IO_
265 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char
, *next_char
);
272 * The cool thing about this fn is that it allows buf_p and buf_cnt to be
273 * held in registers in the inner loop.
275 * For small caches and embedded systems this is important!
277 static inline int gdb_get_char_fast(struct connection
*connection
,
278 int *next_char
, char **buf_p
, int *buf_cnt
)
280 int retval
= ERROR_OK
;
282 if ((*buf_cnt
)-- > 0) {
283 *next_char
= **buf_p
;
286 connection
->input_pending
= 1;
288 connection
->input_pending
= 0;
290 #ifdef _DEBUG_GDB_IO_
291 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char
, *next_char
);
297 struct gdb_connection
*gdb_con
= connection
->priv
;
298 gdb_con
->buf_p
= *buf_p
;
299 gdb_con
->buf_cnt
= *buf_cnt
;
300 retval
= gdb_get_char_inner(connection
, next_char
);
301 *buf_p
= gdb_con
->buf_p
;
302 *buf_cnt
= gdb_con
->buf_cnt
;
307 static int gdb_get_char(struct connection
*connection
, int *next_char
)
309 struct gdb_connection
*gdb_con
= connection
->priv
;
310 return gdb_get_char_fast(connection
, next_char
, &gdb_con
->buf_p
, &gdb_con
->buf_cnt
);
313 static int gdb_putback_char(struct connection
*connection
, int last_char
)
315 struct gdb_connection
*gdb_con
= connection
->priv
;
317 if (gdb_con
->buf_p
> gdb_con
->buffer
) {
318 *(--gdb_con
->buf_p
) = last_char
;
321 LOG_ERROR("BUG: couldn't put character back");
326 /* The only way we can detect that the socket is closed is the first time
327 * we write to it, we will fail. Subsequent write operations will
328 * succeed. Shudder! */
329 static int gdb_write(struct connection
*connection
, void *data
, int len
)
331 struct gdb_connection
*gdb_con
= connection
->priv
;
333 return ERROR_SERVER_REMOTE_CLOSED
;
335 if (connection_write(connection
, data
, len
) == len
)
338 return ERROR_SERVER_REMOTE_CLOSED
;
341 static int gdb_put_packet_inner(struct connection
*connection
,
342 char *buffer
, int len
)
345 unsigned char my_checksum
= 0;
346 #ifdef _DEBUG_GDB_IO_
351 struct gdb_connection
*gdb_con
= connection
->priv
;
353 for (i
= 0; i
< len
; i
++)
354 my_checksum
+= buffer
[i
];
356 #ifdef _DEBUG_GDB_IO_
358 * At this point we should have nothing in the input queue from GDB,
359 * however sometimes '-' is sent even though we've already received
360 * an ACK (+) for everything we've sent off.
364 retval
= check_pending(connection
, 0, &gotdata
);
365 if (retval
!= ERROR_OK
)
369 retval
= gdb_get_char(connection
, &reply
);
370 if (retval
!= ERROR_OK
)
373 /* fix a problem with some IAR tools */
374 gdb_putback_char(connection
, reply
);
375 LOG_DEBUG("Unexpected start of new packet");
379 LOG_WARNING("Discard unexpected char %c", reply
);
384 #ifdef _DEBUG_GDB_IO_
385 debug_buffer
= strndup(buffer
, len
);
386 LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer
, my_checksum
);
390 char local_buffer
[1024];
391 local_buffer
[0] = '$';
392 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 len
+= snprintf(local_buffer
+ len
, sizeof(local_buffer
) - len
, "#%02x", my_checksum
);
396 retval
= gdb_write(connection
, local_buffer
, len
);
397 if (retval
!= ERROR_OK
)
400 /* larger packets are transmitted directly from caller supplied buffer
401 * by several calls to gdb_write() to avoid dynamic allocation */
402 snprintf(local_buffer
+ 1, sizeof(local_buffer
) - 1, "#%02x", my_checksum
);
403 retval
= gdb_write(connection
, local_buffer
, 1);
404 if (retval
!= ERROR_OK
)
406 retval
= gdb_write(connection
, buffer
, len
);
407 if (retval
!= ERROR_OK
)
409 retval
= gdb_write(connection
, local_buffer
+ 1, 3);
410 if (retval
!= ERROR_OK
)
414 if (gdb_con
->noack_mode
)
417 retval
= gdb_get_char(connection
, &reply
);
418 if (retval
!= ERROR_OK
)
423 else if (reply
== '-') {
424 /* Stop sending output packets for now */
425 log_remove_callback(gdb_log_callback
, connection
);
426 LOG_WARNING("negative reply, retrying");
427 } else if (reply
== 0x3) {
429 retval
= gdb_get_char(connection
, &reply
);
430 if (retval
!= ERROR_OK
)
434 else if (reply
== '-') {
435 /* Stop sending output packets for now */
436 log_remove_callback(gdb_log_callback
, connection
);
437 LOG_WARNING("negative reply, retrying");
438 } else if (reply
== '$') {
439 LOG_ERROR("GDB missing ack(1) - assumed good");
440 gdb_putback_char(connection
, reply
);
443 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply
);
445 return ERROR_SERVER_REMOTE_CLOSED
;
447 } else if (reply
== '$') {
448 LOG_ERROR("GDB missing ack(2) - assumed good");
449 gdb_putback_char(connection
, reply
);
452 LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection",
455 return ERROR_SERVER_REMOTE_CLOSED
;
459 return ERROR_SERVER_REMOTE_CLOSED
;
464 int gdb_put_packet(struct connection
*connection
, char *buffer
, int len
)
466 struct gdb_connection
*gdb_con
= connection
->priv
;
468 int retval
= gdb_put_packet_inner(connection
, buffer
, len
);
471 /* we sent some data, reset timer for keep alive messages */
477 static inline int fetch_packet(struct connection
*connection
,
478 int *checksum_ok
, int noack
, int *len
, char *buffer
)
480 unsigned char my_checksum
= 0;
483 int retval
= ERROR_OK
;
485 struct gdb_connection
*gdb_con
= connection
->priv
;
490 /* move this over into local variables to use registers and give the
491 * more freedom to optimize */
492 char *buf_p
= gdb_con
->buf_p
;
493 int buf_cnt
= gdb_con
->buf_cnt
;
496 /* The common case is that we have an entire packet with no escape chars.
497 * We need to leave at least 2 bytes in the buffer to have
498 * gdb_get_char() update various bits and bobs correctly.
500 if ((buf_cnt
> 2) && ((buf_cnt
+ count
) < *len
)) {
501 /* The compiler will struggle a bit with constant propagation and
502 * aliasing, so we help it by showing that these values do not
503 * change inside the loop
507 int run
= buf_cnt
- 2;
513 if (character
== '#') {
514 /* Danger! character can be '#' when esc is
515 * used so we need an explicit boolean for done here. */
520 if (character
== '}') {
521 /* data transmitted in binary mode (X packet)
522 * uses 0x7d as escape character */
523 my_checksum
+= character
& 0xff;
526 my_checksum
+= character
& 0xff;
527 buffer
[count
++] = (character
^ 0x20) & 0xff;
529 my_checksum
+= character
& 0xff;
530 buffer
[count
++] = character
& 0xff;
539 LOG_ERROR("packet buffer too small");
540 retval
= ERROR_GDB_BUFFER_TOO_SMALL
;
544 retval
= gdb_get_char_fast(connection
, &character
, &buf_p
, &buf_cnt
);
545 if (retval
!= ERROR_OK
)
548 if (character
== '#')
551 if (character
== '}') {
552 /* data transmitted in binary mode (X packet)
553 * uses 0x7d as escape character */
554 my_checksum
+= character
& 0xff;
556 retval
= gdb_get_char_fast(connection
, &character
, &buf_p
, &buf_cnt
);
557 if (retval
!= ERROR_OK
)
560 my_checksum
+= character
& 0xff;
561 buffer
[count
++] = (character
^ 0x20) & 0xff;
563 my_checksum
+= character
& 0xff;
564 buffer
[count
++] = character
& 0xff;
568 gdb_con
->buf_p
= buf_p
;
569 gdb_con
->buf_cnt
= buf_cnt
;
571 if (retval
!= ERROR_OK
)
576 retval
= gdb_get_char(connection
, &character
);
577 if (retval
!= ERROR_OK
)
579 checksum
[0] = character
;
580 retval
= gdb_get_char(connection
, &character
);
581 if (retval
!= ERROR_OK
)
583 checksum
[1] = character
;
587 *checksum_ok
= (my_checksum
== strtoul(checksum
, NULL
, 16));
592 static int gdb_get_packet_inner(struct connection
*connection
,
593 char *buffer
, int *len
)
597 struct gdb_connection
*gdb_con
= connection
->priv
;
601 retval
= gdb_get_char(connection
, &character
);
602 if (retval
!= ERROR_OK
)
605 #ifdef _DEBUG_GDB_IO_
606 LOG_DEBUG("character: '%c'", character
);
613 /* gdb sends a dummy ack '+' at every remote connect - see
614 * remote_start_remote (remote.c)
615 * in case anyone tries to debug why they receive this
616 * warning every time */
617 LOG_WARNING("acknowledgment received, but no packet pending");
620 LOG_WARNING("negative acknowledgment, but no packet pending");
627 LOG_WARNING("ignoring character 0x%x", character
);
630 } while (character
!= '$');
633 /* explicit code expansion here to get faster inlined code in -O3 by not
634 * calculating checksum */
635 if (gdb_con
->noack_mode
) {
636 retval
= fetch_packet(connection
, &checksum_ok
, 1, len
, buffer
);
637 if (retval
!= ERROR_OK
)
640 retval
= fetch_packet(connection
, &checksum_ok
, 0, len
, buffer
);
641 if (retval
!= ERROR_OK
)
645 if (gdb_con
->noack_mode
) {
646 /* checksum is not checked in noack mode */
650 retval
= gdb_write(connection
, "+", 1);
651 if (retval
!= ERROR_OK
)
657 return ERROR_SERVER_REMOTE_CLOSED
;
662 static int gdb_get_packet(struct connection
*connection
, char *buffer
, int *len
)
664 struct gdb_connection
*gdb_con
= connection
->priv
;
666 int retval
= gdb_get_packet_inner(connection
, buffer
, len
);
671 static int gdb_output_con(struct connection
*connection
, const char *line
)
676 bin_size
= strlen(line
);
678 hex_buffer
= malloc(bin_size
* 2 + 2);
679 if (hex_buffer
== NULL
)
680 return ERROR_GDB_BUFFER_TOO_SMALL
;
683 int pkt_len
= hexify(hex_buffer
+ 1, line
, bin_size
, bin_size
* 2 + 1);
684 int retval
= gdb_put_packet(connection
, hex_buffer
, pkt_len
+ 1);
690 static int gdb_output(struct command_context
*context
, const char *line
)
692 /* this will be dumped to the log and also sent as an O packet if possible */
693 LOG_USER_N("%s", line
);
697 static void gdb_signal_reply(struct target
*target
, struct connection
*connection
)
699 struct gdb_connection
*gdb_connection
= connection
->priv
;
701 char stop_reason
[20];
705 if (target
->debug_reason
== DBG_REASON_EXIT
) {
706 sig_reply_len
= snprintf(sig_reply
, sizeof(sig_reply
), "W00");
708 if (gdb_connection
->ctrl_c
) {
710 gdb_connection
->ctrl_c
= 0;
712 signal_var
= gdb_last_signal(target
);
714 stop_reason
[0] = '\0';
715 if (target
->debug_reason
== DBG_REASON_WATCHPOINT
) {
716 enum watchpoint_rw hit_wp_type
;
717 uint32_t hit_wp_address
;
719 if (watchpoint_hit(target
, &hit_wp_type
, &hit_wp_address
) == ERROR_OK
) {
721 switch (hit_wp_type
) {
723 snprintf(stop_reason
, sizeof(stop_reason
),
724 "watch:%08x;", hit_wp_address
);
727 snprintf(stop_reason
, sizeof(stop_reason
),
728 "rwatch:%08x;", hit_wp_address
);
731 snprintf(stop_reason
, sizeof(stop_reason
),
732 "awatch:%08x;", hit_wp_address
);
740 sig_reply_len
= snprintf(sig_reply
, sizeof(sig_reply
), "T%2.2x%s",
741 signal_var
, stop_reason
);
744 gdb_put_packet(connection
, sig_reply
, sig_reply_len
);
745 gdb_connection
->frontend_state
= TARGET_HALTED
;
746 rtos_update_threads(target
);
749 static void gdb_fileio_reply(struct target
*target
, struct connection
*connection
)
751 struct gdb_connection
*gdb_connection
= connection
->priv
;
752 char fileio_command
[256];
754 bool program_exited
= false;
756 if (strcmp(target
->fileio_info
->identifier
, "open") == 0)
757 sprintf(fileio_command
, "F%s,%x/%x,%x,%x", target
->fileio_info
->identifier
,
758 target
->fileio_info
->param_1
,
759 target
->fileio_info
->param_2
,
760 target
->fileio_info
->param_3
,
761 target
->fileio_info
->param_4
);
762 else if (strcmp(target
->fileio_info
->identifier
, "close") == 0)
763 sprintf(fileio_command
, "F%s,%x", target
->fileio_info
->identifier
,
764 target
->fileio_info
->param_1
);
765 else if (strcmp(target
->fileio_info
->identifier
, "read") == 0)
766 sprintf(fileio_command
, "F%s,%x,%x,%x", target
->fileio_info
->identifier
,
767 target
->fileio_info
->param_1
,
768 target
->fileio_info
->param_2
,
769 target
->fileio_info
->param_3
);
770 else if (strcmp(target
->fileio_info
->identifier
, "write") == 0)
771 sprintf(fileio_command
, "F%s,%x,%x,%x", target
->fileio_info
->identifier
,
772 target
->fileio_info
->param_1
,
773 target
->fileio_info
->param_2
,
774 target
->fileio_info
->param_3
);
775 else if (strcmp(target
->fileio_info
->identifier
, "lseek") == 0)
776 sprintf(fileio_command
, "F%s,%x,%x,%x", target
->fileio_info
->identifier
,
777 target
->fileio_info
->param_1
,
778 target
->fileio_info
->param_2
,
779 target
->fileio_info
->param_3
);
780 else if (strcmp(target
->fileio_info
->identifier
, "rename") == 0)
781 sprintf(fileio_command
, "F%s,%x/%x,%x/%x", target
->fileio_info
->identifier
,
782 target
->fileio_info
->param_1
,
783 target
->fileio_info
->param_2
,
784 target
->fileio_info
->param_3
,
785 target
->fileio_info
->param_4
);
786 else if (strcmp(target
->fileio_info
->identifier
, "unlink") == 0)
787 sprintf(fileio_command
, "F%s,%x/%x", target
->fileio_info
->identifier
,
788 target
->fileio_info
->param_1
,
789 target
->fileio_info
->param_2
);
790 else if (strcmp(target
->fileio_info
->identifier
, "stat") == 0)
791 sprintf(fileio_command
, "F%s,%x/%x,%x", target
->fileio_info
->identifier
,
792 target
->fileio_info
->param_1
,
793 target
->fileio_info
->param_2
,
794 target
->fileio_info
->param_3
);
795 else if (strcmp(target
->fileio_info
->identifier
, "fstat") == 0)
796 sprintf(fileio_command
, "F%s,%x,%x", target
->fileio_info
->identifier
,
797 target
->fileio_info
->param_1
,
798 target
->fileio_info
->param_2
);
799 else if (strcmp(target
->fileio_info
->identifier
, "gettimeofday") == 0)
800 sprintf(fileio_command
, "F%s,%x,%x", target
->fileio_info
->identifier
,
801 target
->fileio_info
->param_1
,
802 target
->fileio_info
->param_2
);
803 else if (strcmp(target
->fileio_info
->identifier
, "isatty") == 0)
804 sprintf(fileio_command
, "F%s,%x", target
->fileio_info
->identifier
,
805 target
->fileio_info
->param_1
);
806 else if (strcmp(target
->fileio_info
->identifier
, "system") == 0)
807 sprintf(fileio_command
, "F%s,%x/%x", target
->fileio_info
->identifier
,
808 target
->fileio_info
->param_1
,
809 target
->fileio_info
->param_2
);
810 else if (strcmp(target
->fileio_info
->identifier
, "exit") == 0) {
811 /* If target hits exit syscall, report to GDB the program is terminated.
812 * In addition, let target run its own exit syscall handler. */
813 program_exited
= true;
814 sprintf(fileio_command
, "W%02x", target
->fileio_info
->param_1
);
816 LOG_DEBUG("Unknown syscall: %s", target
->fileio_info
->identifier
);
818 /* encounter unknown syscall, continue */
819 gdb_connection
->frontend_state
= TARGET_RUNNING
;
820 target_resume(target
, 1, 0x0, 0, 0);
824 command_len
= strlen(fileio_command
);
825 gdb_put_packet(connection
, fileio_command
, command_len
);
827 if (program_exited
) {
828 /* Use target_resume() to let target run its own exit syscall handler. */
829 gdb_connection
->frontend_state
= TARGET_RUNNING
;
830 target_resume(target
, 1, 0x0, 0, 0);
832 gdb_connection
->frontend_state
= TARGET_HALTED
;
833 rtos_update_threads(target
);
837 static void gdb_frontend_halted(struct target
*target
, struct connection
*connection
)
839 struct gdb_connection
*gdb_connection
= connection
->priv
;
841 /* In the GDB protocol when we are stepping or continuing execution,
842 * we have a lingering reply. Upon receiving a halted event
843 * when we have that lingering packet, we reply to the original
844 * step or continue packet.
846 * Executing monitor commands can bring the target in and
847 * out of the running state so we'll see lots of TARGET_EVENT_XXX
848 * that are to be ignored.
850 if (gdb_connection
->frontend_state
== TARGET_RUNNING
) {
851 /* stop forwarding log packets! */
852 log_remove_callback(gdb_log_callback
, connection
);
854 /* check fileio first */
855 if (target_get_gdb_fileio_info(target
, target
->fileio_info
) == ERROR_OK
)
856 gdb_fileio_reply(target
, connection
);
858 gdb_signal_reply(target
, connection
);
862 static int gdb_target_callback_event_handler(struct target
*target
,
863 enum target_event event
, void *priv
)
866 struct connection
*connection
= priv
;
867 struct gdb_service
*gdb_service
= connection
->service
->priv
;
869 if (gdb_service
->target
!= target
)
873 case TARGET_EVENT_GDB_HALT
:
874 gdb_frontend_halted(target
, connection
);
876 case TARGET_EVENT_HALTED
:
877 target_call_event_callbacks(target
, TARGET_EVENT_GDB_END
);
879 case TARGET_EVENT_GDB_FLASH_ERASE_START
:
880 retval
= jtag_execute_queue();
881 if (retval
!= ERROR_OK
)
891 static int gdb_new_connection(struct connection
*connection
)
893 struct gdb_connection
*gdb_connection
= malloc(sizeof(struct gdb_connection
));
894 struct gdb_service
*gdb_service
= connection
->service
->priv
;
898 connection
->priv
= gdb_connection
;
900 /* initialize gdb connection information */
901 gdb_connection
->buf_p
= gdb_connection
->buffer
;
902 gdb_connection
->buf_cnt
= 0;
903 gdb_connection
->ctrl_c
= 0;
904 gdb_connection
->frontend_state
= TARGET_HALTED
;
905 gdb_connection
->vflash_image
= NULL
;
906 gdb_connection
->closed
= 0;
907 gdb_connection
->busy
= 0;
908 gdb_connection
->noack_mode
= 0;
909 gdb_connection
->sync
= false;
910 gdb_connection
->mem_write_error
= false;
911 gdb_connection
->attached
= true;
913 /* send ACK to GDB for debug request */
914 gdb_write(connection
, "+", 1);
916 /* output goes through gdb connection */
917 command_set_output_handler(connection
->cmd_ctx
, gdb_output
, connection
);
919 /* we must remove all breakpoints registered to the target as a previous
920 * GDB session could leave dangling breakpoints if e.g. communication
923 breakpoint_clear_target(gdb_service
->target
);
924 watchpoint_clear_target(gdb_service
->target
);
926 /* clean previous rtos session if supported*/
927 if ((gdb_service
->target
->rtos
) && (gdb_service
->target
->rtos
->type
->clean
))
928 gdb_service
->target
->rtos
->type
->clean(gdb_service
->target
);
930 /* remove the initial ACK from the incoming buffer */
931 retval
= gdb_get_char(connection
, &initial_ack
);
932 if (retval
!= ERROR_OK
)
935 /* FIX!!!??? would we actually ever receive a + here???
938 if (initial_ack
!= '+')
939 gdb_putback_char(connection
, initial_ack
);
940 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_ATTACH
);
942 if (gdb_use_memory_map
) {
943 /* Connect must fail if the memory map can't be set up correctly.
945 * This will cause an auto_probe to be invoked, which is either
946 * a no-op or it will fail when the target isn't ready(e.g. not halted).
949 for (i
= 0; i
< flash_get_bank_count(); i
++) {
950 struct flash_bank
*p
;
951 retval
= get_flash_bank_by_num(i
, &p
);
952 if (retval
!= ERROR_OK
) {
953 LOG_ERROR("Connect failed. Consider setting up a gdb-attach event for the target " \
954 "to prepare target for GDB connect, or use 'gdb_memory_map disable'.");
960 gdb_actual_connections
++;
961 LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s",
962 gdb_actual_connections
,
963 target_name(gdb_service
->target
),
964 target_state_name(gdb_service
->target
));
966 /* DANGER! If we fail subsequently, we must remove this handler,
967 * otherwise we occasionally see crashes as the timer can invoke the
970 * register callback to be informed about target events */
971 target_register_event_callback(gdb_target_callback_event_handler
, connection
);
976 static int gdb_connection_closed(struct connection
*connection
)
978 struct gdb_service
*gdb_service
= connection
->service
->priv
;
979 struct gdb_connection
*gdb_connection
= connection
->priv
;
981 /* we're done forwarding messages. Tear down callback before
982 * cleaning up connection.
984 log_remove_callback(gdb_log_callback
, connection
);
986 gdb_actual_connections
--;
987 LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
988 target_name(gdb_service
->target
),
989 target_state_name(gdb_service
->target
),
990 gdb_actual_connections
);
992 /* see if an image built with vFlash commands is left */
993 if (gdb_connection
->vflash_image
) {
994 image_close(gdb_connection
->vflash_image
);
995 free(gdb_connection
->vflash_image
);
996 gdb_connection
->vflash_image
= NULL
;
999 /* if this connection registered a debug-message receiver delete it */
1000 delete_debug_msg_receiver(connection
->cmd_ctx
, gdb_service
->target
);
1002 if (connection
->priv
) {
1003 free(connection
->priv
);
1004 connection
->priv
= NULL
;
1006 LOG_ERROR("BUG: connection->priv == NULL");
1008 target_unregister_event_callback(gdb_target_callback_event_handler
, connection
);
1010 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_END
);
1012 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_DETACH
);
1017 static void gdb_send_error(struct connection
*connection
, uint8_t the_error
)
1020 snprintf(err
, 4, "E%2.2X", the_error
);
1021 gdb_put_packet(connection
, err
, 3);
1024 static int gdb_last_signal_packet(struct connection
*connection
,
1025 char *packet
, int packet_size
)
1027 struct target
*target
= get_target_from_connection(connection
);
1028 struct gdb_connection
*gdb_con
= connection
->priv
;
1032 if (!gdb_con
->attached
) {
1033 /* if we are here we have received a kill packet
1034 * reply W stop reply otherwise gdb gets very unhappy */
1035 gdb_put_packet(connection
, "W00", 3);
1039 signal_var
= gdb_last_signal(target
);
1041 snprintf(sig_reply
, 4, "S%2.2x", signal_var
);
1042 gdb_put_packet(connection
, sig_reply
, 3);
1047 static inline int gdb_reg_pos(struct target
*target
, int pos
, int len
)
1049 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
1052 return len
- 1 - pos
;
1055 /* Convert register to string of bytes. NB! The # of bits in the
1056 * register might be non-divisible by 8(a byte), in which
1057 * case an entire byte is shown.
1059 * NB! the format on the wire is the target endianness
1061 * The format of reg->value is little endian
1064 static void gdb_str_to_target(struct target
*target
,
1065 char *tstr
, struct reg
*reg
)
1072 buf_len
= DIV_ROUND_UP(reg
->size
, 8);
1074 for (i
= 0; i
< buf_len
; i
++) {
1075 int j
= gdb_reg_pos(target
, i
, buf_len
);
1076 tstr
+= sprintf(tstr
, "%02x", buf
[j
]);
1080 /* copy over in register buffer */
1081 static void gdb_target_to_reg(struct target
*target
,
1082 char *tstr
, int str_len
, uint8_t *bin
)
1085 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
1090 for (i
= 0; i
< str_len
; i
+= 2) {
1092 if (sscanf(tstr
+ i
, "%02x", &t
) != 1) {
1093 LOG_ERROR("BUG: unable to convert register value");
1097 int j
= gdb_reg_pos(target
, i
/2, str_len
/2);
1102 static int gdb_get_registers_packet(struct connection
*connection
,
1103 char *packet
, int packet_size
)
1105 struct target
*target
= get_target_from_connection(connection
);
1106 struct reg
**reg_list
;
1109 int reg_packet_size
= 0;
1114 #ifdef _DEBUG_GDB_IO_
1118 if ((target
->rtos
!= NULL
) && (ERROR_OK
== rtos_get_gdb_reg_list(connection
)))
1121 retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
,
1123 if (retval
!= ERROR_OK
)
1124 return gdb_error(connection
, retval
);
1126 for (i
= 0; i
< reg_list_size
; i
++)
1127 reg_packet_size
+= DIV_ROUND_UP(reg_list
[i
]->size
, 8) * 2;
1129 assert(reg_packet_size
> 0);
1131 reg_packet
= malloc(reg_packet_size
+ 1); /* plus one for string termination null */
1132 reg_packet_p
= reg_packet
;
1134 for (i
= 0; i
< reg_list_size
; i
++) {
1135 if (!reg_list
[i
]->valid
)
1136 reg_list
[i
]->type
->get(reg_list
[i
]);
1137 gdb_str_to_target(target
, reg_packet_p
, reg_list
[i
]);
1138 reg_packet_p
+= DIV_ROUND_UP(reg_list
[i
]->size
, 8) * 2;
1141 #ifdef _DEBUG_GDB_IO_
1143 char *reg_packet_p_debug
;
1144 reg_packet_p_debug
= strndup(reg_packet
, reg_packet_size
);
1145 LOG_DEBUG("reg_packet: %s", reg_packet_p_debug
);
1146 free(reg_packet_p_debug
);
1150 gdb_put_packet(connection
, reg_packet
, reg_packet_size
);
1158 static int gdb_set_registers_packet(struct connection
*connection
,
1159 char *packet
, int packet_size
)
1161 struct target
*target
= get_target_from_connection(connection
);
1163 struct reg
**reg_list
;
1168 #ifdef _DEBUG_GDB_IO_
1172 /* skip command character */
1176 if (packet_size
% 2) {
1177 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
1178 return ERROR_SERVER_REMOTE_CLOSED
;
1181 retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
,
1183 if (retval
!= ERROR_OK
)
1184 return gdb_error(connection
, retval
);
1187 for (i
= 0; i
< reg_list_size
; i
++) {
1189 int chars
= (DIV_ROUND_UP(reg_list
[i
]->size
, 8) * 2);
1191 if (packet_p
+ chars
> packet
+ packet_size
)
1192 LOG_ERROR("BUG: register packet is too small for registers");
1194 bin_buf
= malloc(DIV_ROUND_UP(reg_list
[i
]->size
, 8));
1195 gdb_target_to_reg(target
, packet_p
, chars
, bin_buf
);
1197 reg_list
[i
]->type
->set(reg_list
[i
], bin_buf
);
1199 /* advance packet pointer */
1205 /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1208 gdb_put_packet(connection
, "OK", 2);
1213 static int gdb_get_register_packet(struct connection
*connection
,
1214 char *packet
, int packet_size
)
1216 struct target
*target
= get_target_from_connection(connection
);
1218 int reg_num
= strtoul(packet
+ 1, NULL
, 16);
1219 struct reg
**reg_list
;
1223 #ifdef _DEBUG_GDB_IO_
1227 retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
,
1229 if (retval
!= ERROR_OK
)
1230 return gdb_error(connection
, retval
);
1232 if (reg_list_size
<= reg_num
) {
1233 LOG_ERROR("gdb requested a non-existing register");
1234 return ERROR_SERVER_REMOTE_CLOSED
;
1237 if (!reg_list
[reg_num
]->valid
)
1238 reg_list
[reg_num
]->type
->get(reg_list
[reg_num
]);
1240 reg_packet
= malloc(DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2 + 1); /* plus one for string termination null */
1242 gdb_str_to_target(target
, reg_packet
, reg_list
[reg_num
]);
1244 gdb_put_packet(connection
, reg_packet
, DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2);
1252 static int gdb_set_register_packet(struct connection
*connection
,
1253 char *packet
, int packet_size
)
1255 struct target
*target
= get_target_from_connection(connection
);
1258 int reg_num
= strtoul(packet
+ 1, &separator
, 16);
1259 struct reg
**reg_list
;
1265 retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
,
1267 if (retval
!= ERROR_OK
)
1268 return gdb_error(connection
, retval
);
1270 if (reg_list_size
<= reg_num
) {
1271 LOG_ERROR("gdb requested a non-existing register");
1272 return ERROR_SERVER_REMOTE_CLOSED
;
1275 if (*separator
!= '=') {
1276 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1277 return ERROR_SERVER_REMOTE_CLOSED
;
1280 /* convert from GDB-string (target-endian) to hex-string (big-endian) */
1281 bin_buf
= malloc(DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8));
1282 int chars
= (DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2);
1284 if ((unsigned int)chars
!= strlen(separator
+ 1)) {
1285 LOG_ERROR("gdb sent a packet with wrong register size");
1287 return ERROR_SERVER_REMOTE_CLOSED
;
1290 gdb_target_to_reg(target
, separator
+ 1, chars
, bin_buf
);
1292 reg_list
[reg_num
]->type
->set(reg_list
[reg_num
], bin_buf
);
1294 gdb_put_packet(connection
, "OK", 2);
1302 /* No attempt is made to translate the "retval" to
1303 * GDB speak. This has to be done at the calling
1304 * site as no mapping really exists.
1306 static int gdb_error(struct connection
*connection
, int retval
)
1308 LOG_DEBUG("Reporting %i to GDB as generic error", retval
);
1309 gdb_send_error(connection
, EFAULT
);
1313 /* We don't have to worry about the default 2 second timeout for GDB packets,
1314 * because GDB breaks up large memory reads into smaller reads.
1316 * 8191 bytes by the looks of it. Why 8191 bytes instead of 8192?????
1318 static int gdb_read_memory_packet(struct connection
*connection
,
1319 char *packet
, int packet_size
)
1321 struct target
*target
= get_target_from_connection(connection
);
1329 int retval
= ERROR_OK
;
1331 /* skip command character */
1334 addr
= strtoul(packet
, &separator
, 16);
1336 if (*separator
!= ',') {
1337 LOG_ERROR("incomplete read memory packet received, dropping connection");
1338 return ERROR_SERVER_REMOTE_CLOSED
;
1341 len
= strtoul(separator
+ 1, NULL
, 16);
1343 buffer
= malloc(len
);
1345 LOG_DEBUG("addr: 0x%8.8" PRIx32
", len: 0x%8.8" PRIx32
"", addr
, len
);
1347 retval
= target_read_buffer(target
, addr
, len
, buffer
);
1349 if ((retval
!= ERROR_OK
) && !gdb_report_data_abort
) {
1350 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1351 * At some point this might be fixed in GDB, in which case this code can be removed.
1353 * OpenOCD developers are acutely aware of this problem, but there is nothing
1354 * gained by involving the user in this problem that hopefully will get resolved
1357 * http://sourceware.org/cgi-bin/gnatsweb.pl? \
1358 * cmd = view%20audit-trail&database = gdb&pr = 2395
1360 * For now, the default is to fix up things to make current GDB versions work.
1361 * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1363 memset(buffer
, 0, len
);
1367 if (retval
== ERROR_OK
) {
1368 hex_buffer
= malloc(len
* 2 + 1);
1370 int pkt_len
= hexify(hex_buffer
, (char *)buffer
, len
, len
* 2 + 1);
1372 gdb_put_packet(connection
, hex_buffer
, pkt_len
);
1376 retval
= gdb_error(connection
, retval
);
1383 static int gdb_write_memory_packet(struct connection
*connection
,
1384 char *packet
, int packet_size
)
1386 struct target
*target
= get_target_from_connection(connection
);
1394 /* skip command character */
1397 addr
= strtoul(packet
, &separator
, 16);
1399 if (*separator
!= ',') {
1400 LOG_ERROR("incomplete write memory packet received, dropping connection");
1401 return ERROR_SERVER_REMOTE_CLOSED
;
1404 len
= strtoul(separator
+ 1, &separator
, 16);
1406 if (*(separator
++) != ':') {
1407 LOG_ERROR("incomplete write memory packet received, dropping connection");
1408 return ERROR_SERVER_REMOTE_CLOSED
;
1411 buffer
= malloc(len
);
1413 LOG_DEBUG("addr: 0x%8.8" PRIx32
", len: 0x%8.8" PRIx32
"", addr
, len
);
1415 if (unhexify((char *)buffer
, separator
, len
) != (int)len
)
1416 LOG_ERROR("unable to decode memory packet");
1418 retval
= target_write_buffer(target
, addr
, len
, buffer
);
1420 if (retval
== ERROR_OK
)
1421 gdb_put_packet(connection
, "OK", 2);
1423 retval
= gdb_error(connection
, retval
);
1430 static int gdb_write_memory_binary_packet(struct connection
*connection
,
1431 char *packet
, int packet_size
)
1433 struct target
*target
= get_target_from_connection(connection
);
1438 int retval
= ERROR_OK
;
1440 /* skip command character */
1443 addr
= strtoul(packet
, &separator
, 16);
1445 if (*separator
!= ',') {
1446 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1447 return ERROR_SERVER_REMOTE_CLOSED
;
1450 len
= strtoul(separator
+ 1, &separator
, 16);
1452 if (*(separator
++) != ':') {
1453 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1454 return ERROR_SERVER_REMOTE_CLOSED
;
1457 struct gdb_connection
*gdb_connection
= connection
->priv
;
1459 if (gdb_connection
->mem_write_error
) {
1460 retval
= ERROR_FAIL
;
1461 /* now that we have reported the memory write error, we can clear the condition */
1462 gdb_connection
->mem_write_error
= false;
1465 /* By replying the packet *immediately* GDB will send us a new packet
1466 * while we write the last one to the target.
1468 if (retval
== ERROR_OK
)
1469 gdb_put_packet(connection
, "OK", 2);
1471 retval
= gdb_error(connection
, retval
);
1472 if (retval
!= ERROR_OK
)
1477 LOG_DEBUG("addr: 0x%8.8" PRIx32
", len: 0x%8.8" PRIx32
"", addr
, len
);
1479 retval
= target_write_buffer(target
, addr
, len
, (uint8_t *)separator
);
1480 if (retval
!= ERROR_OK
)
1481 gdb_connection
->mem_write_error
= true;
1487 static int gdb_step_continue_packet(struct connection
*connection
,
1488 char *packet
, int packet_size
)
1490 struct target
*target
= get_target_from_connection(connection
);
1492 uint32_t address
= 0x0;
1493 int retval
= ERROR_OK
;
1497 if (packet_size
> 1) {
1498 packet
[packet_size
] = 0;
1499 address
= strtoul(packet
+ 1, NULL
, 16);
1503 gdb_running_type
= packet
[0];
1504 if (packet
[0] == 'c') {
1505 LOG_DEBUG("continue");
1506 /* resume at current address, don't handle breakpoints, not debugging */
1507 retval
= target_resume(target
, current
, address
, 0, 0);
1508 } else if (packet
[0] == 's') {
1510 /* step at current or address, don't handle breakpoints */
1511 retval
= target_step(target
, current
, address
, 0);
1516 static int gdb_breakpoint_watchpoint_packet(struct connection
*connection
,
1517 char *packet
, int packet_size
)
1519 struct target
*target
= get_target_from_connection(connection
);
1521 enum breakpoint_type bp_type
= BKPT_SOFT
/* dummy init to avoid warning */;
1522 enum watchpoint_rw wp_type
= WPT_READ
/* dummy init to avoid warning */;
1530 type
= strtoul(packet
+ 1, &separator
, 16);
1532 if (type
== 0) /* memory breakpoint */
1533 bp_type
= BKPT_SOFT
;
1534 else if (type
== 1) /* hardware breakpoint */
1535 bp_type
= BKPT_HARD
;
1536 else if (type
== 2) /* write watchpoint */
1537 wp_type
= WPT_WRITE
;
1538 else if (type
== 3) /* read watchpoint */
1540 else if (type
== 4) /* access watchpoint */
1541 wp_type
= WPT_ACCESS
;
1543 LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type
);
1544 return ERROR_SERVER_REMOTE_CLOSED
;
1547 if (gdb_breakpoint_override
&& ((bp_type
== BKPT_SOFT
) || (bp_type
== BKPT_HARD
)))
1548 bp_type
= gdb_breakpoint_override_type
;
1550 if (*separator
!= ',') {
1551 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1552 return ERROR_SERVER_REMOTE_CLOSED
;
1555 address
= strtoul(separator
+ 1, &separator
, 16);
1557 if (*separator
!= ',') {
1558 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1559 return ERROR_SERVER_REMOTE_CLOSED
;
1562 size
= strtoul(separator
+ 1, &separator
, 16);
1567 if (packet
[0] == 'Z') {
1568 retval
= breakpoint_add(target
, address
, size
, bp_type
);
1569 if (retval
!= ERROR_OK
) {
1570 retval
= gdb_error(connection
, retval
);
1571 if (retval
!= ERROR_OK
)
1574 gdb_put_packet(connection
, "OK", 2);
1576 breakpoint_remove(target
, address
);
1577 gdb_put_packet(connection
, "OK", 2);
1584 if (packet
[0] == 'Z') {
1585 retval
= watchpoint_add(target
, address
, size
, wp_type
, 0, 0xffffffffu
);
1586 if (retval
!= ERROR_OK
) {
1587 retval
= gdb_error(connection
, retval
);
1588 if (retval
!= ERROR_OK
)
1591 gdb_put_packet(connection
, "OK", 2);
1593 watchpoint_remove(target
, address
);
1594 gdb_put_packet(connection
, "OK", 2);
1605 /* print out a string and allocate more space as needed,
1606 * mainly used for XML at this point
1608 static void xml_printf(int *retval
, char **xml
, int *pos
, int *size
,
1609 const char *fmt
, ...)
1611 if (*retval
!= ERROR_OK
)
1616 if ((*xml
== NULL
) || (!first
)) {
1617 /* start by 0 to exercise all the code paths.
1618 * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1620 *size
= *size
* 2 + 2;
1622 *xml
= realloc(*xml
, *size
);
1626 *retval
= ERROR_SERVER_REMOTE_CLOSED
;
1634 ret
= vsnprintf(*xml
+ *pos
, *size
- *pos
, fmt
, ap
);
1636 if ((ret
> 0) && ((ret
+ 1) < *size
- *pos
)) {
1640 /* there was just enough or not enough space, allocate more. */
1645 static int decode_xfer_read(char *buf
, char **annex
, int *ofs
, unsigned int *len
)
1649 /* Extract and NUL-terminate the annex. */
1651 while (*buf
&& *buf
!= ':')
1657 /* After the read marker and annex, qXfer looks like a
1658 * traditional 'm' packet. */
1660 *ofs
= strtoul(buf
, &separator
, 16);
1662 if (*separator
!= ',')
1665 *len
= strtoul(separator
+ 1, NULL
, 16);
1670 static int compare_bank(const void *a
, const void *b
)
1672 struct flash_bank
*b1
, *b2
;
1673 b1
= *((struct flash_bank
**)a
);
1674 b2
= *((struct flash_bank
**)b
);
1676 if (b1
->base
== b2
->base
)
1678 else if (b1
->base
> b2
->base
)
1684 static int gdb_memory_map(struct connection
*connection
,
1685 char *packet
, int packet_size
)
1687 /* We get away with only specifying flash here. Regions that are not
1688 * specified are treated as if we provided no memory map(if not we
1689 * could detect the holes and mark them as RAM).
1690 * Normally we only execute this code once, but no big deal if we
1691 * have to regenerate it a couple of times.
1694 struct target
*target
= get_target_from_connection(connection
);
1695 struct flash_bank
*p
;
1699 int retval
= ERROR_OK
;
1700 struct flash_bank
**banks
;
1704 uint32_t ram_start
= 0;
1706 int target_flash_banks
= 0;
1708 /* skip command character */
1711 offset
= strtoul(packet
, &separator
, 16);
1712 length
= strtoul(separator
+ 1, &separator
, 16);
1714 xml_printf(&retval
, &xml
, &pos
, &size
, "<memory-map>\n");
1716 /* Sort banks in ascending order. We need to report non-flash
1717 * memory as ram (or rather read/write) by default for GDB, since
1718 * it has no concept of non-cacheable read/write memory (i/o etc).
1720 * FIXME Most non-flash addresses are *NOT* RAM! Don't lie.
1721 * Current versions of GDB assume unlisted addresses are RAM...
1723 banks
= malloc(sizeof(struct flash_bank
*)*flash_get_bank_count());
1725 for (i
= 0; i
< flash_get_bank_count(); i
++) {
1726 retval
= get_flash_bank_by_num(i
, &p
);
1727 if (retval
!= ERROR_OK
) {
1729 gdb_error(connection
, retval
);
1732 if (p
->target
== target
)
1733 banks
[target_flash_banks
++] = p
;
1736 qsort(banks
, target_flash_banks
, sizeof(struct flash_bank
*),
1739 for (i
= 0; i
< target_flash_banks
; i
++) {
1741 unsigned sector_size
= 0;
1747 if (ram_start
< p
->base
)
1748 xml_printf(&retval
, &xml
, &pos
, &size
,
1749 "<memory type=\"ram\" start=\"0x%x\" "
1750 "length=\"0x%x\"/>\n",
1751 ram_start
, p
->base
- ram_start
);
1753 /* Report adjacent groups of same-size sectors. So for
1754 * example top boot CFI flash will list an initial region
1755 * with several large sectors (maybe 128KB) and several
1756 * smaller ones at the end (maybe 32KB). STR7 will have
1757 * regions with 8KB, 32KB, and 64KB sectors; etc.
1759 for (j
= 0; j
< p
->num_sectors
; j
++) {
1762 /* Maybe start a new group of sectors. */
1763 if (sector_size
== 0) {
1764 start
= p
->base
+ p
->sectors
[j
].offset
;
1765 xml_printf(&retval
, &xml
, &pos
, &size
,
1766 "<memory type=\"flash\" "
1769 sector_size
= p
->sectors
[j
].size
;
1772 /* Does this finish a group of sectors?
1773 * If not, continue an already-started group.
1775 if (j
== p
->num_sectors
- 1)
1776 group_len
= (p
->base
+ p
->size
) - start
;
1777 else if (p
->sectors
[j
+ 1].size
!= sector_size
)
1778 group_len
= p
->base
+ p
->sectors
[j
+ 1].offset
1783 xml_printf(&retval
, &xml
, &pos
, &size
,
1784 "length=\"0x%x\">\n"
1785 "<property name=\"blocksize\">"
1793 ram_start
= p
->base
+ p
->size
;
1797 xml_printf(&retval
, &xml
, &pos
, &size
,
1798 "<memory type=\"ram\" start=\"0x%x\" "
1799 "length=\"0x%x\"/>\n",
1800 ram_start
, 0-ram_start
);
1801 /* ELSE a flash chip could be at the very end of the 32 bit address
1802 * space, in which case ram_start will be precisely 0
1808 xml_printf(&retval
, &xml
, &pos
, &size
, "</memory-map>\n");
1810 if (retval
!= ERROR_OK
) {
1811 gdb_error(connection
, retval
);
1815 if (offset
+ length
> pos
)
1816 length
= pos
- offset
;
1818 char *t
= malloc(length
+ 1);
1820 memcpy(t
+ 1, xml
+ offset
, length
);
1821 gdb_put_packet(connection
, t
, length
+ 1);
1828 static const char *gdb_get_reg_type_name(enum reg_type type
)
1835 case REG_TYPE_INT16
:
1837 case REG_TYPE_INT32
:
1839 case REG_TYPE_INT64
:
1841 case REG_TYPE_INT128
:
1843 case REG_TYPE_UINT8
:
1845 case REG_TYPE_UINT16
:
1847 case REG_TYPE_UINT32
:
1849 case REG_TYPE_UINT64
:
1851 case REG_TYPE_UINT128
:
1853 case REG_TYPE_CODE_PTR
:
1855 case REG_TYPE_DATA_PTR
:
1857 case REG_TYPE_FLOAT
:
1859 case REG_TYPE_IEEE_SINGLE
:
1860 return "ieee_single";
1861 case REG_TYPE_IEEE_DOUBLE
:
1862 return "ieee_double";
1863 case REG_TYPE_ARCH_DEFINED
:
1864 return "int"; /* return arbitrary string to avoid compile warning. */
1867 return "int"; /* "int" as default value */
1870 static int gdb_generate_reg_type_description(struct target
*target
,
1871 char **tdesc
, int *pos
, int *size
, struct reg_data_type
*type
)
1873 int retval
= ERROR_OK
;
1875 if (type
->type_class
== REG_TYPE_CLASS_VECTOR
) {
1876 /* <vector id="id" type="type" count="count"/> */
1877 xml_printf(&retval
, tdesc
, pos
, size
,
1878 "<vector id=\"%s\" type=\"%s\" count=\"%d\"/>\n",
1879 type
->id
, type
->reg_type_vector
->type
->id
,
1880 type
->reg_type_vector
->count
);
1882 } else if (type
->type_class
== REG_TYPE_CLASS_UNION
) {
1884 * <field name="name" type="type"/> ...
1886 xml_printf(&retval
, tdesc
, pos
, size
,
1887 "<union id=\"%s\">\n",
1890 struct reg_data_type_union_field
*field
;
1891 field
= type
->reg_type_union
->fields
;
1892 while (field
!= NULL
) {
1893 xml_printf(&retval
, tdesc
, pos
, size
,
1894 "<field name=\"%s\" type=\"%s\"/>\n",
1895 field
->name
, field
->type
->id
);
1897 field
= field
->next
;
1900 xml_printf(&retval
, tdesc
, pos
, size
,
1903 } else if (type
->type_class
== REG_TYPE_CLASS_STRUCT
) {
1904 struct reg_data_type_struct_field
*field
;
1905 field
= type
->reg_type_struct
->fields
;
1907 if (field
->use_bitfields
) {
1908 /* <struct id="id" size="size">
1909 * <field name="name" start="start" end="end"/> ...
1911 xml_printf(&retval
, tdesc
, pos
, size
,
1912 "<struct id=\"%s\" size=\"%d\">\n",
1913 type
->id
, type
->reg_type_struct
->size
);
1914 while (field
!= NULL
) {
1915 xml_printf(&retval
, tdesc
, pos
, size
,
1916 "<field name=\"%s\" start=\"%d\" end=\"%d\"/>\n",
1917 field
->name
, field
->bitfield
->start
,
1918 field
->bitfield
->end
);
1920 field
= field
->next
;
1924 * <field name="name" type="type"/> ...
1926 xml_printf(&retval
, tdesc
, pos
, size
,
1927 "<struct id=\"%s\">\n",
1929 while (field
!= NULL
) {
1930 xml_printf(&retval
, tdesc
, pos
, size
,
1931 "<field name=\"%s\" type=\"%s\"/>\n",
1932 field
->name
, field
->type
->id
);
1934 field
= field
->next
;
1938 xml_printf(&retval
, tdesc
, pos
, size
,
1941 } else if (type
->type_class
== REG_TYPE_CLASS_FLAGS
) {
1942 /* <flags id="id" size="size">
1943 * <field name="name" start="start" end="end"/> ...
1945 xml_printf(&retval
, tdesc
, pos
, size
,
1946 "<flags id=\"%s\" size=\"%d\">\n",
1947 type
->id
, type
->reg_type_flags
->size
);
1949 struct reg_data_type_flags_field
*field
;
1950 field
= type
->reg_type_flags
->fields
;
1951 while (field
!= NULL
) {
1952 xml_printf(&retval
, tdesc
, pos
, size
,
1953 "<field name=\"%s\" start=\"%d\" end=\"%d\"/>\n",
1954 field
->name
, field
->bitfield
->start
, field
->bitfield
->end
);
1956 field
= field
->next
;
1959 xml_printf(&retval
, tdesc
, pos
, size
,
1967 /* Get a list of available target registers features. feature_list must
1968 * be freed by caller.
1970 int get_reg_features_list(struct target
*target
, char **feature_list
[], int *feature_list_size
,
1971 struct reg
**reg_list
, int reg_list_size
)
1975 /* Start with only one element */
1976 *feature_list
= calloc(1, sizeof(char *));
1978 for (int i
= 0; i
< reg_list_size
; i
++) {
1979 if (reg_list
[i
]->exist
== false)
1982 if ((reg_list
[i
]->feature
->name
!= NULL
)
1983 && (strcmp(reg_list
[i
]->feature
->name
, ""))) {
1984 /* We found a feature, check if the feature is already in the
1985 * table. If not, allocate a new entry for the table and
1986 * put the new feature in it.
1988 for (int j
= 0; j
< (tbl_sz
+ 1); j
++) {
1989 if (!((*feature_list
)[j
])) {
1990 (*feature_list
)[tbl_sz
++] = strdup(reg_list
[i
]->feature
->name
);
1991 *feature_list
= realloc(*feature_list
, sizeof(char *) * (tbl_sz
+ 1));
1992 (*feature_list
)[tbl_sz
] = NULL
;
1995 if (!strcmp((*feature_list
)[j
], reg_list
[i
]->feature
->name
))
2002 if (feature_list_size
)
2003 *feature_list_size
= tbl_sz
;
2008 static int gdb_generate_target_description(struct target
*target
, char **tdesc
)
2010 int retval
= ERROR_OK
;
2011 struct reg
**reg_list
;
2016 xml_printf(&retval
, tdesc
, &pos
, &size
,
2017 "<?xml version=\"1.0\"?>\n"
2018 "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">\n"
2019 "<target version=\"1.0\">\n");
2021 retval
= target_get_gdb_reg_list(target
, ®_list
,
2022 ®_list_size
, REG_CLASS_ALL
);
2024 if (retval
!= ERROR_OK
) {
2025 LOG_ERROR("get register list failed");
2029 if (reg_list_size
<= 0)
2032 char **features
= NULL
;
2033 /* Get a list of available target registers features */
2034 retval
= get_reg_features_list(target
, &features
, NULL
, reg_list
, reg_list_size
);
2035 if (retval
!= ERROR_OK
) {
2036 LOG_ERROR("Can't get the registers feature list");
2040 /* If we found some features associated with registers, create sections */
2041 int current_feature
= 0;
2043 /* generate target description according to register list */
2044 if (features
!= NULL
) {
2045 while (features
[current_feature
]) {
2047 xml_printf(&retval
, tdesc
, &pos
, &size
,
2048 "<feature name=\"%s\">\n",
2049 features
[current_feature
]);
2052 for (i
= 0; i
< reg_list_size
; i
++) {
2054 if (reg_list
[i
]->exist
== false)
2057 if (strcmp(reg_list
[i
]->feature
->name
, features
[current_feature
]))
2060 const char *type_str
;
2061 if (reg_list
[i
]->reg_data_type
!= NULL
) {
2062 if (reg_list
[i
]->reg_data_type
->type
== REG_TYPE_ARCH_DEFINED
) {
2063 /* generate <type... first, if there are architecture-defined types. */
2064 gdb_generate_reg_type_description(target
, tdesc
, &pos
, &size
,
2065 reg_list
[i
]->reg_data_type
);
2067 type_str
= reg_list
[i
]->reg_data_type
->id
;
2069 /* predefined type */
2070 type_str
= gdb_get_reg_type_name(
2071 reg_list
[i
]->reg_data_type
->type
);
2074 /* Default type is "int" */
2078 xml_printf(&retval
, tdesc
, &pos
, &size
,
2079 "<reg name=\"%s\"", reg_list
[i
]->name
);
2080 xml_printf(&retval
, tdesc
, &pos
, &size
,
2081 " bitsize=\"%d\"", reg_list
[i
]->size
);
2082 xml_printf(&retval
, tdesc
, &pos
, &size
,
2083 " regnum=\"%d\"", reg_list
[i
]->number
);
2084 if (reg_list
[i
]->caller_save
)
2085 xml_printf(&retval
, tdesc
, &pos
, &size
,
2086 " save-restore=\"yes\"");
2088 xml_printf(&retval
, tdesc
, &pos
, &size
,
2089 " save-restore=\"no\"");
2091 xml_printf(&retval
, tdesc
, &pos
, &size
,
2092 " type=\"%s\"", type_str
);
2094 if (reg_list
[i
]->group
!= NULL
)
2095 xml_printf(&retval
, tdesc
, &pos
, &size
,
2096 " group=\"%s\"", reg_list
[i
]->group
);
2098 xml_printf(&retval
, tdesc
, &pos
, &size
,
2102 xml_printf(&retval
, tdesc
, &pos
, &size
,
2109 xml_printf(&retval
, tdesc
, &pos
, &size
,
2112 if (reg_list
!= NULL
)
2115 if (features
!= NULL
)
2121 static int gdb_get_target_description_chunk(struct target
*target
, char **chunk
,
2122 int32_t offset
, uint32_t length
)
2125 static uint32_t tdesc_length
;
2127 if (tdesc
== NULL
) {
2128 gdb_generate_target_description(target
, &tdesc
);
2129 tdesc_length
= strlen(tdesc
);
2134 if (length
< (tdesc_length
- offset
))
2135 transfer_type
= 'm';
2137 transfer_type
= 'l';
2139 *chunk
= malloc(length
+ 2);
2140 (*chunk
)[0] = transfer_type
;
2141 if (transfer_type
== 'm') {
2142 strncpy((*chunk
) + 1, tdesc
+ offset
, length
);
2143 (*chunk
)[1 + length
] = '\0';
2145 strncpy((*chunk
) + 1, tdesc
+ offset
, tdesc_length
- offset
);
2146 (*chunk
)[1 + (tdesc_length
- offset
)] = '\0';
2148 /* After gdb-server sends out last chunk, invalidate tdesc. */
2157 static int gdb_target_description_supported(struct target
*target
, int *supported
)
2159 int retval
= ERROR_OK
;
2160 struct reg
**reg_list
= NULL
;
2161 int reg_list_size
= 0;
2162 int feature_list_size
= 0;
2164 retval
= target_get_gdb_reg_list(target
, ®_list
,
2165 ®_list_size
, REG_CLASS_ALL
);
2166 if (retval
!= ERROR_OK
) {
2167 LOG_ERROR("get register list failed");
2171 if (reg_list_size
<= 0) {
2172 retval
= ERROR_FAIL
;
2176 char **features
= NULL
;
2177 /* Get a list of available target registers features */
2178 retval
= get_reg_features_list(target
, &features
, &feature_list_size
, reg_list
, reg_list_size
);
2179 if (retval
!= ERROR_OK
) {
2180 LOG_ERROR("Can't get the registers feature list");
2185 if (feature_list_size
)
2192 if (reg_list
!= NULL
)
2195 if (features
!= NULL
)
2201 static int gdb_query_packet(struct connection
*connection
,
2202 char *packet
, int packet_size
)
2204 struct command_context
*cmd_ctx
= connection
->cmd_ctx
;
2205 struct gdb_connection
*gdb_connection
= connection
->priv
;
2206 struct target
*target
= get_target_from_connection(connection
);
2208 if (strncmp(packet
, "qRcmd,", 6) == 0) {
2209 if (packet_size
> 6) {
2211 cmd
= malloc((packet_size
- 6) / 2 + 1);
2212 int len
= unhexify(cmd
, packet
+ 6, (packet_size
- 6) / 2);
2215 /* We want to print all debug output to GDB connection */
2216 log_add_callback(gdb_log_callback
, connection
);
2217 target_call_timer_callbacks_now();
2218 /* some commands need to know the GDB connection, make note of current
2219 * GDB connection. */
2220 current_gdb_connection
= gdb_connection
;
2221 command_run_line(cmd_ctx
, cmd
);
2222 current_gdb_connection
= NULL
;
2223 target_call_timer_callbacks_now();
2224 log_remove_callback(gdb_log_callback
, connection
);
2227 gdb_put_packet(connection
, "OK", 2);
2229 } else if (strncmp(packet
, "qCRC:", 5) == 0) {
2230 if (packet_size
> 5) {
2238 /* skip command character */
2241 addr
= strtoul(packet
, &separator
, 16);
2243 if (*separator
!= ',') {
2244 LOG_ERROR("incomplete read memory packet received, dropping connection");
2245 return ERROR_SERVER_REMOTE_CLOSED
;
2248 len
= strtoul(separator
+ 1, NULL
, 16);
2250 retval
= target_checksum_memory(target
, addr
, len
, &checksum
);
2252 if (retval
== ERROR_OK
) {
2253 snprintf(gdb_reply
, 10, "C%8.8" PRIx32
"", checksum
);
2254 gdb_put_packet(connection
, gdb_reply
, 9);
2256 retval
= gdb_error(connection
, retval
);
2257 if (retval
!= ERROR_OK
)
2263 } else if (strncmp(packet
, "qSupported", 10) == 0) {
2264 /* we currently support packet size and qXfer:memory-map:read (if enabled)
2265 * qXfer:features:read is supported for some targets */
2266 int retval
= ERROR_OK
;
2267 char *buffer
= NULL
;
2270 int gdb_target_desc_supported
= 0;
2272 /* we need to test that the target supports target descriptions */
2273 retval
= gdb_target_description_supported(target
, &gdb_target_desc_supported
);
2274 if (retval
!= ERROR_OK
) {
2275 LOG_INFO("Failed detecting Target Description Support, disabling");
2276 gdb_target_desc_supported
= 0;
2279 /* support may be disabled globally */
2280 if (gdb_use_target_description
== 0) {
2281 if (gdb_target_desc_supported
)
2282 LOG_WARNING("Target Descriptions Supported, but disabled");
2283 gdb_target_desc_supported
= 0;
2290 "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read%c;QStartNoAckMode+",
2291 (GDB_BUFFER_SIZE
- 1),
2292 ((gdb_use_memory_map
== 1) && (flash_get_bank_count() > 0)) ? '+' : '-',
2293 (gdb_target_desc_supported
== 1) ? '+' : '-');
2295 if (retval
!= ERROR_OK
) {
2296 gdb_send_error(connection
, 01);
2300 gdb_put_packet(connection
, buffer
, strlen(buffer
));
2304 } else if ((strncmp(packet
, "qXfer:memory-map:read::", 23) == 0)
2305 && (flash_get_bank_count() > 0))
2306 return gdb_memory_map(connection
, packet
, packet_size
);
2307 else if (strncmp(packet
, "qXfer:features:read:", 20) == 0) {
2309 int retval
= ERROR_OK
;
2312 unsigned int length
;
2315 /* skip command character */
2318 if (decode_xfer_read(packet
, &annex
, &offset
, &length
) < 0) {
2319 gdb_send_error(connection
, 01);
2323 /* Target should prepare correct target description for annex.
2324 * The first character of returned xml is 'm' or 'l'. 'm' for
2325 * there are *more* chunks to transfer. 'l' for it is the *last*
2326 * chunk of target description.
2328 retval
= gdb_get_target_description_chunk(target
, &xml
, offset
, length
);
2329 if (retval
!= ERROR_OK
) {
2330 gdb_error(connection
, retval
);
2334 gdb_put_packet(connection
, xml
, strlen(xml
));
2338 } else if (strncmp(packet
, "QStartNoAckMode", 15) == 0) {
2339 gdb_connection
->noack_mode
= 1;
2340 gdb_put_packet(connection
, "OK", 2);
2344 gdb_put_packet(connection
, "", 0);
2348 static int gdb_v_packet(struct connection
*connection
,
2349 char *packet
, int packet_size
)
2351 struct gdb_connection
*gdb_connection
= connection
->priv
;
2352 struct gdb_service
*gdb_service
= connection
->service
->priv
;
2355 /* if flash programming disabled - send a empty reply */
2357 if (gdb_flash_program
== 0) {
2358 gdb_put_packet(connection
, "", 0);
2362 if (strncmp(packet
, "vFlashErase:", 12) == 0) {
2364 unsigned long length
;
2366 char *parse
= packet
+ 12;
2367 if (*parse
== '\0') {
2368 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2369 return ERROR_SERVER_REMOTE_CLOSED
;
2372 addr
= strtoul(parse
, &parse
, 16);
2374 if (*(parse
++) != ',' || *parse
== '\0') {
2375 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2376 return ERROR_SERVER_REMOTE_CLOSED
;
2379 length
= strtoul(parse
, &parse
, 16);
2381 if (*parse
!= '\0') {
2382 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2383 return ERROR_SERVER_REMOTE_CLOSED
;
2386 /* assume all sectors need erasing - stops any problems
2387 * when flash_write is called multiple times */
2390 /* perform any target specific operations before the erase */
2391 target_call_event_callbacks(gdb_service
->target
,
2392 TARGET_EVENT_GDB_FLASH_ERASE_START
);
2394 /* vFlashErase:addr,length messages require region start and
2395 * end to be "block" aligned ... if padding is ever needed,
2396 * GDB will have become dangerously confused.
2398 result
= flash_erase_address_range(gdb_service
->target
,
2399 false, addr
, length
);
2401 /* perform any target specific operations after the erase */
2402 target_call_event_callbacks(gdb_service
->target
,
2403 TARGET_EVENT_GDB_FLASH_ERASE_END
);
2406 if (result
!= ERROR_OK
) {
2407 /* GDB doesn't evaluate the actual error number returned,
2408 * treat a failed erase as an I/O error
2410 gdb_send_error(connection
, EIO
);
2411 LOG_ERROR("flash_erase returned %i", result
);
2413 gdb_put_packet(connection
, "OK", 2);
2418 if (strncmp(packet
, "vFlashWrite:", 12) == 0) {
2421 unsigned long length
;
2422 char *parse
= packet
+ 12;
2424 if (*parse
== '\0') {
2425 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2426 return ERROR_SERVER_REMOTE_CLOSED
;
2428 addr
= strtoul(parse
, &parse
, 16);
2429 if (*(parse
++) != ':') {
2430 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2431 return ERROR_SERVER_REMOTE_CLOSED
;
2433 length
= packet_size
- (parse
- packet
);
2435 /* create a new image if there isn't already one */
2436 if (gdb_connection
->vflash_image
== NULL
) {
2437 gdb_connection
->vflash_image
= malloc(sizeof(struct image
));
2438 image_open(gdb_connection
->vflash_image
, "", "build");
2441 /* create new section with content from packet buffer */
2442 retval
= image_add_section(gdb_connection
->vflash_image
,
2443 addr
, length
, 0x0, (uint8_t *)parse
);
2444 if (retval
!= ERROR_OK
)
2447 gdb_put_packet(connection
, "OK", 2);
2452 if (strncmp(packet
, "vFlashDone", 10) == 0) {
2455 /* process the flashing buffer. No need to erase as GDB
2456 * always issues a vFlashErase first. */
2457 target_call_event_callbacks(gdb_service
->target
,
2458 TARGET_EVENT_GDB_FLASH_WRITE_START
);
2459 result
= flash_write(gdb_service
->target
, gdb_connection
->vflash_image
, &written
, 0);
2460 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_FLASH_WRITE_END
);
2461 if (result
!= ERROR_OK
) {
2462 if (result
== ERROR_FLASH_DST_OUT_OF_BANK
)
2463 gdb_put_packet(connection
, "E.memtype", 9);
2465 gdb_send_error(connection
, EIO
);
2467 LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written
);
2468 gdb_put_packet(connection
, "OK", 2);
2471 image_close(gdb_connection
->vflash_image
);
2472 free(gdb_connection
->vflash_image
);
2473 gdb_connection
->vflash_image
= NULL
;
2478 gdb_put_packet(connection
, "", 0);
2482 static int gdb_detach(struct connection
*connection
)
2484 struct gdb_service
*gdb_service
= connection
->service
->priv
;
2486 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_DETACH
);
2488 return gdb_put_packet(connection
, "OK", 2);
2491 /* The format of 'F' response packet is
2492 * Fretcode,errno,Ctrl-C flag;call-specific attachment
2494 static int gdb_fileio_response_packet(struct connection
*connection
,
2495 char *packet
, int packet_size
)
2497 struct target
*target
= get_target_from_connection(connection
);
2499 char *parsing_point
;
2500 int fileio_retcode
= strtoul(packet
+ 1, &separator
, 16);
2501 int fileio_errno
= 0;
2502 bool fileio_ctrl_c
= false;
2507 if (*separator
== ',') {
2508 parsing_point
= separator
+ 1;
2509 fileio_errno
= strtoul(parsing_point
, &separator
, 16);
2510 if (*separator
== ',') {
2511 if (*(separator
+ 1) == 'C') {
2512 /* TODO: process ctrl-c */
2513 fileio_ctrl_c
= true;
2518 LOG_DEBUG("File-I/O response, retcode: 0x%x, errno: 0x%x, ctrl-c: %s",
2519 fileio_retcode
, fileio_errno
, fileio_ctrl_c
? "true" : "false");
2521 retval
= target_gdb_fileio_end(target
, fileio_retcode
, fileio_errno
, fileio_ctrl_c
);
2522 if (retval
!= ERROR_OK
)
2525 /* After File-I/O ends, keep continue or step */
2526 if (gdb_running_type
== 'c')
2527 retval
= target_resume(target
, 1, 0x0, 0, 0);
2528 else if (gdb_running_type
== 's')
2529 retval
= target_step(target
, 1, 0x0, 0);
2531 retval
= ERROR_FAIL
;
2533 if (retval
!= ERROR_OK
)
2539 static void gdb_log_callback(void *priv
, const char *file
, unsigned line
,
2540 const char *function
, const char *string
)
2542 struct connection
*connection
= priv
;
2543 struct gdb_connection
*gdb_con
= connection
->priv
;
2545 if (gdb_con
->busy
) {
2546 /* do not reply this using the O packet */
2550 gdb_output_con(connection
, string
);
2553 static void gdb_sig_halted(struct connection
*connection
)
2556 snprintf(sig_reply
, 4, "T%2.2x", 2);
2557 gdb_put_packet(connection
, sig_reply
, 3);
2560 static int gdb_input_inner(struct connection
*connection
)
2562 /* Do not allocate this on the stack */
2563 static char gdb_packet_buffer
[GDB_BUFFER_SIZE
];
2565 struct gdb_service
*gdb_service
= connection
->service
->priv
;
2566 struct target
*target
= gdb_service
->target
;
2567 char *packet
= gdb_packet_buffer
;
2570 struct gdb_connection
*gdb_con
= connection
->priv
;
2571 static int extended_protocol
;
2573 /* drain input buffer. If one of the packets fail, then an error
2574 * packet is replied, if applicable.
2576 * This loop will terminate and the error code is returned.
2578 * The calling fn will check if this error is something that
2579 * can be recovered from, or if the connection must be closed.
2581 * If the error is recoverable, this fn is called again to
2582 * drain the rest of the buffer.
2585 packet_size
= GDB_BUFFER_SIZE
-1;
2586 retval
= gdb_get_packet(connection
, packet
, &packet_size
);
2587 if (retval
!= ERROR_OK
)
2590 /* terminate with zero */
2591 packet
[packet_size
] = 0;
2593 if (LOG_LEVEL_IS(LOG_LVL_DEBUG
)) {
2594 if (packet
[0] == 'X') {
2595 /* binary packets spew junk into the debug log stream */
2598 for (x
= 0; (x
< 49) && (packet
[x
] != ':'); x
++)
2601 LOG_DEBUG("received packet: '%s:<binary-data>'", buf
);
2603 LOG_DEBUG("received packet: '%s'", packet
);
2606 if (packet_size
> 0) {
2608 switch (packet
[0]) {
2609 case 'T': /* Is thread alive? */
2610 gdb_thread_packet(connection
, packet
, packet_size
);
2612 case 'H': /* Set current thread ( 'c' for step and continue,
2613 * 'g' for all other operations ) */
2614 gdb_thread_packet(connection
, packet
, packet_size
);
2618 retval
= gdb_thread_packet(connection
, packet
, packet_size
);
2619 if (retval
== GDB_THREAD_PACKET_NOT_CONSUMED
)
2620 retval
= gdb_query_packet(connection
, packet
, packet_size
);
2623 retval
= gdb_get_registers_packet(connection
, packet
, packet_size
);
2626 retval
= gdb_set_registers_packet(connection
, packet
, packet_size
);
2629 retval
= gdb_get_register_packet(connection
, packet
, packet_size
);
2632 retval
= gdb_set_register_packet(connection
, packet
, packet_size
);
2635 retval
= gdb_read_memory_packet(connection
, packet
, packet_size
);
2638 retval
= gdb_write_memory_packet(connection
, packet
, packet_size
);
2642 retval
= gdb_breakpoint_watchpoint_packet(connection
, packet
, packet_size
);
2645 gdb_last_signal_packet(connection
, packet
, packet_size
);
2650 gdb_thread_packet(connection
, packet
, packet_size
);
2651 log_add_callback(gdb_log_callback
, connection
);
2653 if (gdb_con
->mem_write_error
) {
2654 LOG_ERROR("Memory write failure!");
2656 /* now that we have reported the memory write error,
2657 * we can clear the condition */
2658 gdb_con
->mem_write_error
= false;
2661 bool nostep
= false;
2662 bool already_running
= false;
2663 if (target
->state
== TARGET_RUNNING
) {
2664 LOG_WARNING("WARNING! The target is already running. "
2665 "All changes GDB did to registers will be discarded! "
2666 "Waiting for target to halt.");
2667 already_running
= true;
2668 } else if (target
->state
!= TARGET_HALTED
) {
2669 LOG_WARNING("The target is not in the halted nor running stated, " \
2670 "stepi/continue ignored.");
2672 } else if ((packet
[0] == 's') && gdb_con
->sync
) {
2673 /* Hmm..... when you issue a continue in GDB, then a "stepi" is
2674 * sent by GDB first to OpenOCD, thus defeating the check to
2675 * make only the single stepping have the sync feature...
2678 LOG_WARNING("stepi ignored. GDB will now fetch the register state " \
2679 "from the target.");
2681 gdb_con
->sync
= false;
2683 if (!already_running
&& nostep
) {
2684 /* Either the target isn't in the halted state, then we can't
2685 * step/continue. This might be early setup, etc.
2687 * Or we want to allow GDB to pick up a fresh set of
2688 * register values without modifying the target state.
2691 gdb_sig_halted(connection
);
2693 /* stop forwarding log packets! */
2694 log_remove_callback(gdb_log_callback
, connection
);
2696 /* We're running/stepping, in which case we can
2697 * forward log output until the target is halted
2699 gdb_con
->frontend_state
= TARGET_RUNNING
;
2700 target_call_event_callbacks(target
, TARGET_EVENT_GDB_START
);
2702 if (!already_running
) {
2703 /* Here we don't want packet processing to stop even if this fails,
2704 * so we use a local variable instead of retval. */
2705 retval
= gdb_step_continue_packet(connection
, packet
, packet_size
);
2706 if (retval
!= ERROR_OK
) {
2707 /* we'll never receive a halted
2708 * condition... issue a false one..
2710 gdb_frontend_halted(target
, connection
);
2717 retval
= gdb_v_packet(connection
, packet
, packet_size
);
2720 retval
= gdb_detach(connection
);
2721 extended_protocol
= 0;
2724 retval
= gdb_write_memory_binary_packet(connection
, packet
, packet_size
);
2725 if (retval
!= ERROR_OK
)
2729 if (extended_protocol
!= 0) {
2730 gdb_con
->attached
= false;
2733 gdb_put_packet(connection
, "OK", 2);
2734 return ERROR_SERVER_REMOTE_CLOSED
;
2736 /* handle extended remote protocol */
2737 extended_protocol
= 1;
2738 gdb_put_packet(connection
, "OK", 2);
2741 /* handle extended restart packet */
2742 breakpoint_clear_target(gdb_service
->target
);
2743 watchpoint_clear_target(gdb_service
->target
);
2744 command_run_linef(connection
->cmd_ctx
, "ocd_gdb_restart %s",
2745 target_name(target
));
2746 /* set connection as attached after reset */
2747 gdb_con
->attached
= true;
2748 /* info rtos parts */
2749 gdb_thread_packet(connection
, packet
, packet_size
);
2753 /* packet supported only by smp target i.e cortex_a.c*/
2754 /* handle smp packet replying coreid played to gbd */
2755 gdb_read_smp_packet(connection
, packet
, packet_size
);
2759 /* packet supported only by smp target i.e cortex_a.c */
2760 /* handle smp packet setting coreid to be played at next
2762 gdb_write_smp_packet(connection
, packet
, packet_size
);
2766 /* File-I/O extension */
2767 /* After gdb uses host-side syscall to complete target file
2768 * I/O, gdb sends host-side syscall return value to target
2770 * The format of 'F' response packet is
2771 * Fretcode,errno,Ctrl-C flag;call-specific attachment
2773 gdb_con
->frontend_state
= TARGET_RUNNING
;
2774 log_add_callback(gdb_log_callback
, connection
);
2775 gdb_fileio_response_packet(connection
, packet
, packet_size
);
2779 /* ignore unknown packets */
2780 LOG_DEBUG("ignoring 0x%2.2x packet", packet
[0]);
2781 gdb_put_packet(connection
, NULL
, 0);
2785 /* if a packet handler returned an error, exit input loop */
2786 if (retval
!= ERROR_OK
)
2790 if (gdb_con
->ctrl_c
) {
2791 if (target
->state
== TARGET_RUNNING
) {
2792 retval
= target_halt(target
);
2793 if (retval
!= ERROR_OK
)
2794 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
2795 gdb_con
->ctrl_c
= 0;
2797 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
2798 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
2802 } while (gdb_con
->buf_cnt
> 0);
2807 static int gdb_input(struct connection
*connection
)
2809 int retval
= gdb_input_inner(connection
);
2810 struct gdb_connection
*gdb_con
= connection
->priv
;
2811 if (retval
== ERROR_SERVER_REMOTE_CLOSED
)
2814 /* logging does not propagate the error, yet can set the gdb_con->closed flag */
2815 if (gdb_con
->closed
)
2816 return ERROR_SERVER_REMOTE_CLOSED
;
2818 /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
2822 static int gdb_target_start(struct target
*target
, const char *port
)
2824 struct gdb_service
*gdb_service
;
2826 gdb_service
= malloc(sizeof(struct gdb_service
));
2828 if (NULL
== gdb_service
)
2831 gdb_service
->target
= target
;
2832 gdb_service
->core
[0] = -1;
2833 gdb_service
->core
[1] = -1;
2834 target
->gdb_service
= gdb_service
;
2836 ret
= add_service("gdb",
2837 port
, 1, &gdb_new_connection
, &gdb_input
,
2838 &gdb_connection_closed
, gdb_service
);
2839 /* initialialize all targets gdb service with the same pointer */
2841 struct target_list
*head
;
2842 struct target
*curr
;
2843 head
= target
->head
;
2844 while (head
!= (struct target_list
*)NULL
) {
2845 curr
= head
->target
;
2847 curr
->gdb_service
= gdb_service
;
2854 static int gdb_target_add_one(struct target
*target
)
2856 /* one gdb instance per smp list */
2857 if ((target
->smp
) && (target
->gdb_service
))
2859 int retval
= gdb_target_start(target
, gdb_port_next
);
2860 if (retval
== ERROR_OK
) {
2862 /* If we can parse the port number
2863 * then we increment the port number for the next target.
2866 portnumber
= strtol(gdb_port_next
, &end
, 0);
2868 if (parse_long(gdb_port_next
, &portnumber
) == ERROR_OK
) {
2869 free((void *)gdb_port_next
);
2870 gdb_port_next
= alloc_printf("%d", portnumber
+1);
2877 int gdb_target_add_all(struct target
*target
)
2879 if (NULL
== target
) {
2880 LOG_WARNING("gdb services need one or more targets defined");
2884 while (NULL
!= target
) {
2885 int retval
= gdb_target_add_one(target
);
2886 if (ERROR_OK
!= retval
)
2889 target
= target
->next
;
2895 COMMAND_HANDLER(handle_gdb_sync_command
)
2898 return ERROR_COMMAND_SYNTAX_ERROR
;
2900 if (current_gdb_connection
== NULL
) {
2901 command_print(CMD_CTX
,
2902 "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
2906 current_gdb_connection
->sync
= true;
2911 /* daemon configuration command gdb_port */
2912 COMMAND_HANDLER(handle_gdb_port_command
)
2914 int retval
= CALL_COMMAND_HANDLER(server_pipe_command
, &gdb_port
);
2915 if (ERROR_OK
== retval
) {
2916 free((void *)gdb_port_next
);
2917 gdb_port_next
= strdup(gdb_port
);
2922 COMMAND_HANDLER(handle_gdb_memory_map_command
)
2925 return ERROR_COMMAND_SYNTAX_ERROR
;
2927 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_use_memory_map
);
2931 COMMAND_HANDLER(handle_gdb_flash_program_command
)
2934 return ERROR_COMMAND_SYNTAX_ERROR
;
2936 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_flash_program
);
2940 COMMAND_HANDLER(handle_gdb_report_data_abort_command
)
2943 return ERROR_COMMAND_SYNTAX_ERROR
;
2945 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_report_data_abort
);
2949 /* gdb_breakpoint_override */
2950 COMMAND_HANDLER(handle_gdb_breakpoint_override_command
)
2952 if (CMD_ARGC
== 0) {
2954 } else if (CMD_ARGC
== 1) {
2955 gdb_breakpoint_override
= 1;
2956 if (strcmp(CMD_ARGV
[0], "hard") == 0)
2957 gdb_breakpoint_override_type
= BKPT_HARD
;
2958 else if (strcmp(CMD_ARGV
[0], "soft") == 0)
2959 gdb_breakpoint_override_type
= BKPT_SOFT
;
2960 else if (strcmp(CMD_ARGV
[0], "disable") == 0)
2961 gdb_breakpoint_override
= 0;
2963 return ERROR_COMMAND_SYNTAX_ERROR
;
2964 if (gdb_breakpoint_override
)
2965 LOG_USER("force %s breakpoints",
2966 (gdb_breakpoint_override_type
== BKPT_HARD
) ? "hard" : "soft");
2968 LOG_USER("breakpoint type is not overridden");
2973 COMMAND_HANDLER(handle_gdb_target_description_command
)
2976 return ERROR_COMMAND_SYNTAX_ERROR
;
2978 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_use_target_description
);
2982 COMMAND_HANDLER(handle_gdb_save_tdesc_command
)
2985 static uint32_t tdesc_length
;
2986 struct target
*target
= get_current_target(CMD_CTX
);
2987 char *tdesc_filename
;
2989 if (tdesc
== NULL
) {
2990 gdb_generate_target_description(target
, &tdesc
);
2991 tdesc_length
= strlen(tdesc
);
2994 struct fileio fileio
;
2995 size_t size_written
;
2997 tdesc_filename
= malloc(strlen(target_type_name(target
)) + 5);
2998 sprintf(tdesc_filename
, "%s.xml", target_type_name(target
));
3000 int retval
= fileio_open(&fileio
, tdesc_filename
, FILEIO_WRITE
, FILEIO_TEXT
);
3002 if (retval
!= ERROR_OK
) {
3003 LOG_WARNING("Can't open %s for writing", tdesc_filename
);
3004 free(tdesc_filename
);
3008 retval
= fileio_write(&fileio
, tdesc_length
, tdesc
, &size_written
);
3010 fileio_close(&fileio
);
3011 free(tdesc_filename
);
3013 if (retval
!= ERROR_OK
) {
3014 LOG_WARNING("Error while writing the tdesc file");
3021 static const struct command_registration gdb_command_handlers
[] = {
3024 .handler
= handle_gdb_sync_command
,
3025 .mode
= COMMAND_ANY
,
3026 .help
= "next stepi will return immediately allowing "
3027 "GDB to fetch register state without affecting "
3033 .handler
= handle_gdb_port_command
,
3034 .mode
= COMMAND_ANY
,
3035 .help
= "Normally gdb listens to a TCP/IP port. Each subsequent GDB "
3036 "server listens for the next port number after the "
3037 "base port number specified. "
3038 "No arguments reports GDB port. \"pipe\" means listen to stdin "
3039 "output to stdout, an integer is base port number, \"disable\" disables "
3040 "port. Any other string is are interpreted as named pipe to listen to. "
3041 "Output pipe is the same name as input pipe, but with 'o' appended.",
3042 .usage
= "[port_num]",
3045 .name
= "gdb_memory_map",
3046 .handler
= handle_gdb_memory_map_command
,
3047 .mode
= COMMAND_CONFIG
,
3048 .help
= "enable or disable memory map",
3049 .usage
= "('enable'|'disable')"
3052 .name
= "gdb_flash_program",
3053 .handler
= handle_gdb_flash_program_command
,
3054 .mode
= COMMAND_CONFIG
,
3055 .help
= "enable or disable flash program",
3056 .usage
= "('enable'|'disable')"
3059 .name
= "gdb_report_data_abort",
3060 .handler
= handle_gdb_report_data_abort_command
,
3061 .mode
= COMMAND_CONFIG
,
3062 .help
= "enable or disable reporting data aborts",
3063 .usage
= "('enable'|'disable')"
3066 .name
= "gdb_breakpoint_override",
3067 .handler
= handle_gdb_breakpoint_override_command
,
3068 .mode
= COMMAND_ANY
,
3069 .help
= "Display or specify type of breakpoint "
3070 "to be used by gdb 'break' commands.",
3071 .usage
= "('hard'|'soft'|'disable')"
3074 .name
= "gdb_target_description",
3075 .handler
= handle_gdb_target_description_command
,
3076 .mode
= COMMAND_CONFIG
,
3077 .help
= "enable or disable target description",
3078 .usage
= "('enable'|'disable')"
3081 .name
= "gdb_save_tdesc",
3082 .handler
= handle_gdb_save_tdesc_command
,
3083 .mode
= COMMAND_EXEC
,
3084 .help
= "Save the target description file",
3086 COMMAND_REGISTRATION_DONE
3089 int gdb_register_commands(struct command_context
*cmd_ctx
)
3091 gdb_port
= strdup("3333");
3092 gdb_port_next
= strdup("3333");
3093 return register_commands(cmd_ctx
, NULL
, gdb_command_handlers
);