1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Ø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 "breakpoints.h"
31 #include "target_request.h"
35 #include "gdb_server.h"
41 #define _DEBUG_GDB_IO_
44 static struct gdb_connection
*current_gdb_connection
;
46 static int gdb_breakpoint_override
;
47 static enum breakpoint_type gdb_breakpoint_override_type
;
49 extern int gdb_error(struct connection
*connection
, int retval
);
50 static unsigned short gdb_port
= 3333;
51 static const char *DIGITS
= "0123456789abcdef";
53 static void gdb_log_callback(void *priv
, const char *file
, unsigned line
,
54 const char *function
, const char *string
);
56 /* number of gdb connections, mainly to supress gdb related debugging spam
57 * in helper/log.c when no gdb connections are actually active */
58 int gdb_actual_connections
;
60 /* set if we are sending a memory map to gdb
61 * via qXfer:memory-map:read packet */
62 /* enabled by default*/
63 int gdb_use_memory_map
= 1;
64 /* enabled by default*/
65 int gdb_flash_program
= 1;
67 /* if set, data aborts cause an error to be reported in memory read packets
68 * see the code in gdb_read_memory_packet() for further explanations */
69 int gdb_report_data_abort
= 0;
71 int gdb_last_signal(struct target
*target
)
73 switch (target
->debug_reason
)
75 case DBG_REASON_DBGRQ
:
76 return 0x2; /* SIGINT */
77 case DBG_REASON_BREAKPOINT
:
78 case DBG_REASON_WATCHPOINT
:
79 case DBG_REASON_WPTANDBKPT
:
80 return 0x05; /* SIGTRAP */
81 case DBG_REASON_SINGLESTEP
:
82 return 0x05; /* SIGTRAP */
83 case DBG_REASON_NOTHALTED
:
84 return 0x0; /* no signal... shouldn't happen */
86 LOG_USER("undefined debug reason %d - target needs reset", target
->debug_reason
);
91 int check_pending(struct connection
*connection
, int timeout_s
, int *got_data
)
93 /* a non-blocking socket will block if there is 0 bytes available on the socket,
94 * but return with as many bytes as are available immediately
98 struct gdb_connection
*gdb_con
= connection
->priv
;
100 if (got_data
== NULL
)
104 if (gdb_con
->buf_cnt
> 0)
111 FD_SET(connection
->fd
, &read_fds
);
113 tv
.tv_sec
= timeout_s
;
115 if (socket_select(connection
->fd
+ 1, &read_fds
, NULL
, NULL
, &tv
) == 0)
117 /* This can typically be because a "monitor" command took too long
118 * before printing any progress messages
122 return ERROR_GDB_TIMEOUT
;
128 *got_data
= FD_ISSET(connection
->fd
, &read_fds
) != 0;
132 int gdb_get_char(struct connection
*connection
, int* next_char
)
134 struct gdb_connection
*gdb_con
= connection
->priv
;
135 int retval
= ERROR_OK
;
137 #ifdef _DEBUG_GDB_IO_
141 if (gdb_con
->buf_cnt
-- > 0)
143 *next_char
= *(gdb_con
->buf_p
++);
144 if (gdb_con
->buf_cnt
> 0)
145 connection
->input_pending
= 1;
147 connection
->input_pending
= 0;
149 #ifdef _DEBUG_GDB_IO_
150 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char
, *next_char
);
158 if (connection
->service
->type
== CONNECTION_PIPE
)
160 gdb_con
->buf_cnt
= read(connection
->fd
, gdb_con
->buffer
, GDB_BUFFER_SIZE
);
164 retval
= check_pending(connection
, 1, NULL
);
165 if (retval
!= ERROR_OK
)
167 gdb_con
->buf_cnt
= read_socket(connection
->fd
, gdb_con
->buffer
, GDB_BUFFER_SIZE
);
170 if (gdb_con
->buf_cnt
> 0)
174 if (gdb_con
->buf_cnt
== 0)
177 return ERROR_SERVER_REMOTE_CLOSED
;
181 errno
= WSAGetLastError();
188 case WSAECONNABORTED
:
190 return ERROR_SERVER_REMOTE_CLOSED
;
193 return ERROR_SERVER_REMOTE_CLOSED
;
195 LOG_ERROR("read: %d", errno
);
206 return ERROR_SERVER_REMOTE_CLOSED
;
209 return ERROR_SERVER_REMOTE_CLOSED
;
211 LOG_ERROR("read: %s", strerror(errno
));
213 return ERROR_SERVER_REMOTE_CLOSED
;
218 #ifdef _DEBUG_GDB_IO_
219 debug_buffer
= malloc(gdb_con
->buf_cnt
+ 1);
220 memcpy(debug_buffer
, gdb_con
->buffer
, gdb_con
->buf_cnt
);
221 debug_buffer
[gdb_con
->buf_cnt
] = 0;
222 LOG_DEBUG("received '%s'", debug_buffer
);
226 gdb_con
->buf_p
= gdb_con
->buffer
;
228 *next_char
= *(gdb_con
->buf_p
++);
229 if (gdb_con
->buf_cnt
> 0)
230 connection
->input_pending
= 1;
232 connection
->input_pending
= 0;
233 #ifdef _DEBUG_GDB_IO_
234 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char
, *next_char
);
240 int gdb_putback_char(struct connection
*connection
, int last_char
)
242 struct gdb_connection
*gdb_con
= connection
->priv
;
244 if (gdb_con
->buf_p
> gdb_con
->buffer
)
246 *(--gdb_con
->buf_p
) = last_char
;
251 LOG_ERROR("BUG: couldn't put character back");
257 /* The only way we can detect that the socket is closed is the first time
258 * we write to it, we will fail. Subsequent write operations will
259 * succeed. Shudder! */
260 int gdb_write(struct connection
*connection
, void *data
, int len
)
262 struct gdb_connection
*gdb_con
= connection
->priv
;
264 return ERROR_SERVER_REMOTE_CLOSED
;
266 if (connection
->service
->type
== CONNECTION_PIPE
)
268 /* write to stdout */
269 if (write(STDOUT_FILENO
, data
, len
) == len
)
276 if (write_socket(connection
->fd
, data
, len
) == len
)
282 return ERROR_SERVER_REMOTE_CLOSED
;
285 int gdb_put_packet_inner(struct connection
*connection
, char *buffer
, int len
)
288 unsigned char my_checksum
= 0;
289 #ifdef _DEBUG_GDB_IO_
294 struct gdb_connection
*gdb_con
= connection
->priv
;
296 for (i
= 0; i
< len
; i
++)
297 my_checksum
+= buffer
[i
];
299 #ifdef _DEBUG_GDB_IO_
301 * At this point we should have nothing in the input queue from GDB,
302 * however sometimes '-' is sent even though we've already received
303 * an ACK (+) for everything we've sent off.
308 if ((retval
= check_pending(connection
, 0, &gotdata
)) != ERROR_OK
)
312 if ((retval
= gdb_get_char(connection
, &reply
)) != ERROR_OK
)
315 /* fix a problem with some IAR tools */
316 gdb_putback_char(connection
, reply
);
317 LOG_DEBUG("Unexpected start of new packet");
321 LOG_WARNING("Discard unexpected char %c", reply
);
327 #ifdef _DEBUG_GDB_IO_
328 debug_buffer
= malloc(len
+ 1);
329 memcpy(debug_buffer
, buffer
, len
);
330 debug_buffer
[len
] = 0;
331 LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer
, my_checksum
);
335 char local_buffer
[1024];
336 local_buffer
[0] = '$';
337 if ((size_t)len
+ 4 <= sizeof(local_buffer
))
339 /* performance gain on smaller packets by only a single call to gdb_write() */
340 memcpy(local_buffer
+ 1, buffer
, len
++);
341 local_buffer
[len
++] = '#';
342 local_buffer
[len
++] = DIGITS
[(my_checksum
>> 4) & 0xf];
343 local_buffer
[len
++] = DIGITS
[my_checksum
& 0xf];
344 if ((retval
= gdb_write(connection
, local_buffer
, len
)) != ERROR_OK
)
351 /* larger packets are transmitted directly from caller supplied buffer
352 by several calls to gdb_write() to avoid dynamic allocation */
353 local_buffer
[1] = '#';
354 local_buffer
[2] = DIGITS
[(my_checksum
>> 4) & 0xf];
355 local_buffer
[3] = DIGITS
[my_checksum
& 0xf];
356 if ((retval
= gdb_write(connection
, local_buffer
, 1)) != ERROR_OK
)
360 if ((retval
= gdb_write(connection
, buffer
, len
)) != ERROR_OK
)
364 if ((retval
= gdb_write(connection
, local_buffer
+ 1, 3)) != ERROR_OK
)
370 if (gdb_con
->noack_mode
)
373 if ((retval
= gdb_get_char(connection
, &reply
)) != ERROR_OK
)
378 else if (reply
== '-')
380 /* Stop sending output packets for now */
381 log_remove_callback(gdb_log_callback
, connection
);
382 LOG_WARNING("negative reply, retrying");
384 else if (reply
== 0x3)
387 if ((retval
= gdb_get_char(connection
, &reply
)) != ERROR_OK
)
391 else if (reply
== '-')
393 /* Stop sending output packets for now */
394 log_remove_callback(gdb_log_callback
, connection
);
395 LOG_WARNING("negative reply, retrying");
397 else if (reply
== '$') {
398 LOG_ERROR("GDB missing ack(1) - assumed good");
399 gdb_putback_char(connection
, reply
);
403 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply
);
405 return ERROR_SERVER_REMOTE_CLOSED
;
408 else if (reply
== '$') {
409 LOG_ERROR("GDB missing ack(2) - assumed good");
410 gdb_putback_char(connection
, reply
);
415 LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection", reply
);
417 return ERROR_SERVER_REMOTE_CLOSED
;
421 return ERROR_SERVER_REMOTE_CLOSED
;
426 int gdb_put_packet(struct connection
*connection
, char *buffer
, int len
)
428 struct gdb_connection
*gdb_con
= connection
->priv
;
430 int retval
= gdb_put_packet_inner(connection
, buffer
, len
);
433 /* we sent some data, reset timer for keep alive messages */
439 static __inline__
int fetch_packet(struct connection
*connection
, int *checksum_ok
, int noack
, int *len
, char *buffer
)
441 unsigned char my_checksum
= 0;
446 struct gdb_connection
*gdb_con
= connection
->priv
;
452 /* The common case is that we have an entire packet with no escape chars.
453 * We need to leave at least 2 bytes in the buffer to have
454 * gdb_get_char() update various bits and bobs correctly.
456 if ((gdb_con
->buf_cnt
> 2) && ((gdb_con
->buf_cnt
+ count
) < *len
))
458 /* The compiler will struggle a bit with constant propagation and
459 * aliasing, so we help it by showing that these values do not
460 * change inside the loop
463 char *buf
= gdb_con
->buf_p
;
464 int run
= gdb_con
->buf_cnt
- 2;
471 if (character
== '#')
473 /* Danger! character can be '#' when esc is
474 * used so we need an explicit boolean for done here.
480 if (character
== '}')
482 /* data transmitted in binary mode (X packet)
483 * uses 0x7d as escape character */
484 my_checksum
+= character
& 0xff;
487 my_checksum
+= character
& 0xff;
488 buffer
[count
++] = (character
^ 0x20) & 0xff;
492 my_checksum
+= character
& 0xff;
493 buffer
[count
++] = character
& 0xff;
497 gdb_con
->buf_cnt
-= i
;
503 LOG_ERROR("packet buffer too small");
504 return ERROR_GDB_BUFFER_TOO_SMALL
;
507 if ((retval
= gdb_get_char(connection
, &character
)) != ERROR_OK
)
510 if (character
== '#')
513 if (character
== '}')
515 /* data transmitted in binary mode (X packet)
516 * uses 0x7d as escape character */
517 my_checksum
+= character
& 0xff;
518 if ((retval
= gdb_get_char(connection
, &character
)) != ERROR_OK
)
520 my_checksum
+= character
& 0xff;
521 buffer
[count
++] = (character
^ 0x20) & 0xff;
525 my_checksum
+= character
& 0xff;
526 buffer
[count
++] = character
& 0xff;
532 if ((retval
= gdb_get_char(connection
, &character
)) != ERROR_OK
)
534 checksum
[0] = character
;
535 if ((retval
= gdb_get_char(connection
, &character
)) != ERROR_OK
)
537 checksum
[1] = character
;
542 *checksum_ok
= (my_checksum
== strtoul(checksum
, NULL
, 16));
548 int gdb_get_packet_inner(struct connection
*connection
, char *buffer
, int *len
)
552 struct gdb_connection
*gdb_con
= connection
->priv
;
558 if ((retval
= gdb_get_char(connection
, &character
)) != ERROR_OK
)
561 #ifdef _DEBUG_GDB_IO_
562 LOG_DEBUG("character: '%c'", character
);
570 /* gdb sends a dummy ack '+' at every remote connect - see remote_start_remote (remote.c)
571 * incase anyone tries to debug why they receive this warning every time */
572 LOG_WARNING("acknowledgment received, but no packet pending");
575 LOG_WARNING("negative acknowledgment, but no packet pending");
582 LOG_WARNING("ignoring character 0x%x", character
);
585 } while (character
!= '$');
590 /* explicit code expansion here to get faster inlined code in -O3 by not
591 * calculating checksum
593 if (gdb_con
->noack_mode
)
595 if ((retval
= fetch_packet(connection
, &checksum_ok
, 1, len
, buffer
)) != ERROR_OK
)
599 if ((retval
= fetch_packet(connection
, &checksum_ok
, 0, len
, buffer
)) != ERROR_OK
)
603 if (gdb_con
->noack_mode
)
605 /* checksum is not checked in noack mode */
610 if ((retval
= gdb_write(connection
, "+", 1)) != ERROR_OK
)
618 return ERROR_SERVER_REMOTE_CLOSED
;
623 int gdb_get_packet(struct connection
*connection
, char *buffer
, int *len
)
625 struct gdb_connection
*gdb_con
= connection
->priv
;
627 int retval
= gdb_get_packet_inner(connection
, buffer
, len
);
632 int gdb_output_con(struct connection
*connection
, const char* line
)
637 bin_size
= strlen(line
);
639 hex_buffer
= malloc(bin_size
*2 + 2);
640 if (hex_buffer
== NULL
)
641 return ERROR_GDB_BUFFER_TOO_SMALL
;
644 for (i
= 0; i
< bin_size
; i
++)
645 snprintf(hex_buffer
+ 1 + i
*2, 3, "%2.2x", line
[i
]);
646 hex_buffer
[bin_size
*2 + 1] = 0;
648 int retval
= gdb_put_packet(connection
, hex_buffer
, bin_size
*2 + 1);
654 int gdb_output(struct command_context
*context
, const char* line
)
656 /* this will be dumped to the log and also sent as an O packet if possible */
657 LOG_USER_N("%s", line
);
662 static void gdb_frontend_halted(struct target
*target
, struct connection
*connection
)
664 struct gdb_connection
*gdb_connection
= connection
->priv
;
666 /* In the GDB protocol when we are stepping or continuing execution,
667 * we have a lingering reply. Upon receiving a halted event
668 * when we have that lingering packet, we reply to the original
669 * step or continue packet.
671 * Executing monitor commands can bring the target in and
672 * out of the running state so we'll see lots of TARGET_EVENT_XXX
673 * that are to be ignored.
675 if (gdb_connection
->frontend_state
== TARGET_RUNNING
)
680 /* stop forwarding log packets! */
681 log_remove_callback(gdb_log_callback
, connection
);
683 if (gdb_connection
->ctrl_c
)
686 gdb_connection
->ctrl_c
= 0;
690 signal
= gdb_last_signal(target
);
693 snprintf(sig_reply
, 4, "T%2.2x", signal
);
694 gdb_put_packet(connection
, sig_reply
, 3);
695 gdb_connection
->frontend_state
= TARGET_HALTED
;
699 int gdb_target_callback_event_handler(struct target
*target
, enum target_event event
, void *priv
)
702 struct connection
*connection
= priv
;
704 target_handle_event(target
, event
);
707 case TARGET_EVENT_GDB_HALT
:
708 gdb_frontend_halted(target
, connection
);
710 case TARGET_EVENT_HALTED
:
711 target_call_event_callbacks(target
, TARGET_EVENT_GDB_END
);
713 case TARGET_EVENT_GDB_FLASH_ERASE_START
:
714 target_handle_event(target
, TARGET_EVENT_OLD_gdb_program_config
);
715 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
727 int gdb_new_connection(struct connection
*connection
)
729 struct gdb_connection
*gdb_connection
= malloc(sizeof(struct gdb_connection
));
730 struct gdb_service
*gdb_service
= connection
->service
->priv
;
734 connection
->priv
= gdb_connection
;
736 /* initialize gdb connection information */
737 gdb_connection
->buf_p
= gdb_connection
->buffer
;
738 gdb_connection
->buf_cnt
= 0;
739 gdb_connection
->ctrl_c
= 0;
740 gdb_connection
->frontend_state
= TARGET_HALTED
;
741 gdb_connection
->vflash_image
= NULL
;
742 gdb_connection
->closed
= 0;
743 gdb_connection
->busy
= 0;
744 gdb_connection
->noack_mode
= 0;
745 gdb_connection
->sync
= true;
747 /* send ACK to GDB for debug request */
748 gdb_write(connection
, "+", 1);
750 /* output goes through gdb connection */
751 command_set_output_handler(connection
->cmd_ctx
, gdb_output
, connection
);
753 /* we must remove all breakpoints registered to the target as a previous
754 * GDB session could leave dangling breakpoints if e.g. communication
757 breakpoint_clear_target(gdb_service
->target
);
758 watchpoint_clear_target(gdb_service
->target
);
760 /* register callback to be informed about target events */
761 target_register_event_callback(gdb_target_callback_event_handler
, connection
);
763 /* remove the initial ACK from the incoming buffer */
764 if ((retval
= gdb_get_char(connection
, &initial_ack
)) != ERROR_OK
)
767 /* FIX!!!??? would we actually ever receive a + here???
770 if (initial_ack
!= '+')
771 gdb_putback_char(connection
, initial_ack
);
772 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_ATTACH
);
774 gdb_actual_connections
++;
775 LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s",
776 gdb_actual_connections
,
777 gdb_service
->target
->cmd_name
,
778 target_state_name(gdb_service
->target
));
783 int gdb_connection_closed(struct connection
*connection
)
785 struct gdb_service
*gdb_service
= connection
->service
->priv
;
786 struct gdb_connection
*gdb_connection
= connection
->priv
;
788 /* we're done forwarding messages. Tear down callback before
789 * cleaning up connection.
791 log_remove_callback(gdb_log_callback
, connection
);
793 gdb_actual_connections
--;
794 LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
795 gdb_service
->target
->cmd_name
,
796 target_state_name(gdb_service
->target
),
797 gdb_actual_connections
);
799 /* see if an image built with vFlash commands is left */
800 if (gdb_connection
->vflash_image
)
802 image_close(gdb_connection
->vflash_image
);
803 free(gdb_connection
->vflash_image
);
804 gdb_connection
->vflash_image
= NULL
;
807 /* if this connection registered a debug-message receiver delete it */
808 delete_debug_msg_receiver(connection
->cmd_ctx
, gdb_service
->target
);
810 if (connection
->priv
)
812 free(connection
->priv
);
813 connection
->priv
= NULL
;
817 LOG_ERROR("BUG: connection->priv == NULL");
821 target_unregister_event_callback(gdb_target_callback_event_handler
, connection
);
823 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_END
);
825 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_DETACH
);
830 void gdb_send_error(struct connection
*connection
, uint8_t the_error
)
833 snprintf(err
, 4, "E%2.2X", the_error
);
834 gdb_put_packet(connection
, err
, 3);
837 int gdb_last_signal_packet(struct connection
*connection
, struct target
*target
, char* packet
, int packet_size
)
842 signal
= gdb_last_signal(target
);
844 snprintf(sig_reply
, 4, "S%2.2x", signal
);
845 gdb_put_packet(connection
, sig_reply
, 3);
850 static int gdb_reg_pos(struct target
*target
, int pos
, int len
)
852 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
855 return len
- 1 - pos
;
858 /* Convert register to string of bytes. NB! The # of bits in the
859 * register might be non-divisible by 8(a byte), in which
860 * case an entire byte is shown.
862 * NB! the format on the wire is the target endianess
864 * The format of reg->value is little endian
867 void gdb_str_to_target(struct target
*target
, char *tstr
, struct reg
*reg
)
874 buf_len
= DIV_ROUND_UP(reg
->size
, 8);
876 for (i
= 0; i
< buf_len
; i
++)
878 int j
= gdb_reg_pos(target
, i
, buf_len
);
879 tstr
[i
*2] = DIGITS
[(buf
[j
]>>4) & 0xf];
880 tstr
[i
*2 + 1] = DIGITS
[buf
[j
]&0xf];
884 static int hextoint(char c
)
895 LOG_ERROR("BUG: invalid register value %08x", c
);
899 /* copy over in register buffer */
900 void gdb_target_to_reg(struct target
*target
, char *tstr
, int str_len
, uint8_t *bin
)
904 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
909 for (i
= 0; i
< str_len
; i
+= 2)
911 uint8_t t
= hextoint(tstr
[i
]) << 4;
912 t
|= hextoint(tstr
[i
+ 1]);
914 int j
= gdb_reg_pos(target
, i
/2, str_len
/2);
919 int gdb_get_registers_packet(struct connection
*connection
, struct target
*target
, char* packet
, int packet_size
)
921 struct reg
**reg_list
;
924 int reg_packet_size
= 0;
929 #ifdef _DEBUG_GDB_IO_
933 if ((retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
)) != ERROR_OK
)
935 return gdb_error(connection
, retval
);
938 for (i
= 0; i
< reg_list_size
; i
++)
940 reg_packet_size
+= reg_list
[i
]->size
;
943 reg_packet
= malloc(DIV_ROUND_UP(reg_packet_size
, 8) * 2);
944 reg_packet_p
= reg_packet
;
946 for (i
= 0; i
< reg_list_size
; i
++)
948 gdb_str_to_target(target
, reg_packet_p
, reg_list
[i
]);
949 reg_packet_p
+= DIV_ROUND_UP(reg_list
[i
]->size
, 8) * 2;
952 #ifdef _DEBUG_GDB_IO_
955 reg_packet_p
= strndup(reg_packet
, DIV_ROUND_UP(reg_packet_size
, 8) * 2);
956 LOG_DEBUG("reg_packet: %s", reg_packet_p
);
961 gdb_put_packet(connection
, reg_packet
, DIV_ROUND_UP(reg_packet_size
, 8) * 2);
969 int gdb_set_registers_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
972 struct reg
**reg_list
;
977 #ifdef _DEBUG_GDB_IO_
981 /* skip command character */
987 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
988 return ERROR_SERVER_REMOTE_CLOSED
;
991 if ((retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
)) != ERROR_OK
)
993 return gdb_error(connection
, retval
);
997 for (i
= 0; i
< reg_list_size
; i
++)
1000 int chars
= (DIV_ROUND_UP(reg_list
[i
]->size
, 8) * 2);
1002 if (packet_p
+ chars
> packet
+ packet_size
)
1004 LOG_ERROR("BUG: register packet is too small for registers");
1007 struct reg_arch_type
*arch_type
;
1008 bin_buf
= malloc(DIV_ROUND_UP(reg_list
[i
]->size
, 8));
1009 gdb_target_to_reg(target
, packet_p
, chars
, bin_buf
);
1011 /* get register arch_type, and call set method */
1012 arch_type
= register_get_arch_type(reg_list
[i
]->arch_type
);
1014 arch_type
->set(reg_list
[i
], bin_buf
);
1016 /* advance packet pointer */
1023 /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1026 gdb_put_packet(connection
, "OK", 2);
1031 int gdb_get_register_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1034 int reg_num
= strtoul(packet
+ 1, NULL
, 16);
1035 struct reg
**reg_list
;
1039 #ifdef _DEBUG_GDB_IO_
1043 if ((retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
)) != ERROR_OK
)
1045 return gdb_error(connection
, retval
);
1048 if (reg_list_size
<= reg_num
)
1050 LOG_ERROR("gdb requested a non-existing register");
1054 reg_packet
= malloc(DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2);
1056 gdb_str_to_target(target
, reg_packet
, reg_list
[reg_num
]);
1058 gdb_put_packet(connection
, reg_packet
, DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2);
1066 int gdb_set_register_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1070 int reg_num
= strtoul(packet
+ 1, &separator
, 16);
1071 struct reg
**reg_list
;
1074 struct reg_arch_type
*arch_type
;
1078 if ((retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
)) != ERROR_OK
)
1080 return gdb_error(connection
, retval
);
1083 if (reg_list_size
< reg_num
)
1085 LOG_ERROR("gdb requested a non-existing register");
1086 return ERROR_SERVER_REMOTE_CLOSED
;
1089 if (*separator
!= '=')
1091 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1092 return ERROR_SERVER_REMOTE_CLOSED
;
1095 /* convert from GDB-string (target-endian) to hex-string (big-endian) */
1096 bin_buf
= malloc(DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8));
1097 int chars
= (DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2);
1099 /* fix!!! add some sanity checks on packet size here */
1101 gdb_target_to_reg(target
, separator
+ 1, chars
, bin_buf
);
1103 /* get register arch_type, and call set method */
1104 arch_type
= register_get_arch_type(reg_list
[reg_num
]->arch_type
);
1105 arch_type
->set(reg_list
[reg_num
], bin_buf
);
1107 gdb_put_packet(connection
, "OK", 2);
1115 int gdb_error(struct connection
*connection
, int retval
)
1119 case ERROR_TARGET_DATA_ABORT
:
1120 gdb_send_error(connection
, EIO
);
1122 case ERROR_TARGET_TRANSLATION_FAULT
:
1123 gdb_send_error(connection
, EFAULT
);
1125 case ERROR_TARGET_UNALIGNED_ACCESS
:
1126 gdb_send_error(connection
, EFAULT
);
1128 case ERROR_TARGET_NOT_HALTED
:
1129 gdb_send_error(connection
, EFAULT
);
1132 /* This could be that the target reset itself. */
1133 LOG_ERROR("unexpected error %i", retval
);
1134 gdb_send_error(connection
, EFAULT
);
1141 /* We don't have to worry about the default 2 second timeout for GDB packets,
1142 * because GDB breaks up large memory reads into smaller reads.
1144 * 8191 bytes by the looks of it. Why 8191 bytes instead of 8192?????
1146 int gdb_read_memory_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1155 int retval
= ERROR_OK
;
1157 /* skip command character */
1160 addr
= strtoul(packet
, &separator
, 16);
1162 if (*separator
!= ',')
1164 LOG_ERROR("incomplete read memory packet received, dropping connection");
1165 return ERROR_SERVER_REMOTE_CLOSED
;
1168 len
= strtoul(separator
+ 1, NULL
, 16);
1170 buffer
= malloc(len
);
1172 LOG_DEBUG("addr: 0x%8.8" PRIx32
", len: 0x%8.8" PRIx32
"", addr
, len
);
1174 retval
= target_read_buffer(target
, addr
, len
, buffer
);
1176 if ((retval
!= ERROR_OK
)&&!gdb_report_data_abort
)
1178 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1179 * At some point this might be fixed in GDB, in which case this code can be removed.
1181 * OpenOCD developers are acutely aware of this problem, but there is nothing
1182 * gained by involving the user in this problem that hopefully will get resolved
1185 * http://sourceware.org/cgi-bin/gnatsweb.pl?cmd = view%20audit-trail&database = gdb&pr = 2395
1187 * For now, the default is to fix up things to make current GDB versions work.
1188 * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1190 memset(buffer
, 0, len
);
1194 if (retval
== ERROR_OK
)
1196 hex_buffer
= malloc(len
* 2 + 1);
1199 for (i
= 0; i
< len
; i
++)
1201 uint8_t t
= buffer
[i
];
1202 hex_buffer
[2 * i
] = DIGITS
[(t
>> 4) & 0xf];
1203 hex_buffer
[2 * i
+ 1] = DIGITS
[t
& 0xf];
1206 gdb_put_packet(connection
, hex_buffer
, len
* 2);
1212 retval
= gdb_error(connection
, retval
);
1220 int gdb_write_memory_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1231 /* skip command character */
1234 addr
= strtoul(packet
, &separator
, 16);
1236 if (*separator
!= ',')
1238 LOG_ERROR("incomplete write memory packet received, dropping connection");
1239 return ERROR_SERVER_REMOTE_CLOSED
;
1242 len
= strtoul(separator
+ 1, &separator
, 16);
1244 if (*(separator
++) != ':')
1246 LOG_ERROR("incomplete write memory packet received, dropping connection");
1247 return ERROR_SERVER_REMOTE_CLOSED
;
1250 buffer
= malloc(len
);
1252 LOG_DEBUG("addr: 0x%8.8" PRIx32
", len: 0x%8.8" PRIx32
"", addr
, len
);
1254 for (i
= 0; i
< len
; i
++)
1257 sscanf(separator
+ 2*i
, "%2" SCNx32
, &tmp
);
1261 retval
= target_write_buffer(target
, addr
, len
, buffer
);
1263 if (retval
== ERROR_OK
)
1265 gdb_put_packet(connection
, "OK", 2);
1269 retval
= gdb_error(connection
, retval
);
1277 int gdb_write_memory_binary_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1285 /* skip command character */
1288 addr
= strtoul(packet
, &separator
, 16);
1290 if (*separator
!= ',')
1292 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1293 return ERROR_SERVER_REMOTE_CLOSED
;
1296 len
= strtoul(separator
+ 1, &separator
, 16);
1298 if (*(separator
++) != ':')
1300 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1301 return ERROR_SERVER_REMOTE_CLOSED
;
1307 LOG_DEBUG("addr: 0x%8.8" PRIx32
", len: 0x%8.8" PRIx32
"", addr
, len
);
1309 retval
= target_write_buffer(target
, addr
, len
, (uint8_t*)separator
);
1312 if (retval
== ERROR_OK
)
1314 gdb_put_packet(connection
, "OK", 2);
1318 if ((retval
= gdb_error(connection
, retval
)) != ERROR_OK
)
1325 int gdb_step_continue_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1328 uint32_t address
= 0x0;
1329 int retval
= ERROR_OK
;
1333 if (packet_size
> 1)
1335 packet
[packet_size
] = 0;
1336 address
= strtoul(packet
+ 1, NULL
, 16);
1343 if (packet
[0] == 'c')
1345 LOG_DEBUG("continue");
1346 target_handle_event(target
, TARGET_EVENT_OLD_pre_resume
);
1347 retval
= target_resume(target
, current
, address
, 0, 0); /* resume at current address, don't handle breakpoints, not debugging */
1349 else if (packet
[0] == 's')
1352 /* step at current or address, don't handle breakpoints */
1353 retval
= target_step(target
, current
, address
, 0);
1358 int gdb_breakpoint_watchpoint_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1361 enum breakpoint_type bp_type
= BKPT_SOFT
/* dummy init to avoid warning */;
1362 enum watchpoint_rw wp_type
;
1370 type
= strtoul(packet
+ 1, &separator
, 16);
1372 if (type
== 0) /* memory breakpoint */
1373 bp_type
= BKPT_SOFT
;
1374 else if (type
== 1) /* hardware breakpoint */
1375 bp_type
= BKPT_HARD
;
1376 else if (type
== 2) /* write watchpoint */
1377 wp_type
= WPT_WRITE
;
1378 else if (type
== 3) /* read watchpoint */
1380 else if (type
== 4) /* access watchpoint */
1381 wp_type
= WPT_ACCESS
;
1383 if (gdb_breakpoint_override
&& ((bp_type
== BKPT_SOFT
)||(bp_type
== BKPT_HARD
)))
1385 bp_type
= gdb_breakpoint_override_type
;
1388 if (*separator
!= ',')
1390 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1391 return ERROR_SERVER_REMOTE_CLOSED
;
1394 address
= strtoul(separator
+ 1, &separator
, 16);
1396 if (*separator
!= ',')
1398 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1399 return ERROR_SERVER_REMOTE_CLOSED
;
1402 size
= strtoul(separator
+ 1, &separator
, 16);
1408 if (packet
[0] == 'Z')
1410 if ((retval
= breakpoint_add(target
, address
, size
, bp_type
)) != ERROR_OK
)
1412 if ((retval
= gdb_error(connection
, retval
)) != ERROR_OK
)
1417 gdb_put_packet(connection
, "OK", 2);
1422 breakpoint_remove(target
, address
);
1423 gdb_put_packet(connection
, "OK", 2);
1430 if (packet
[0] == 'Z')
1432 if ((retval
= watchpoint_add(target
, address
, size
, type
-2, 0, 0xffffffffu
)) != ERROR_OK
)
1434 if ((retval
= gdb_error(connection
, retval
)) != ERROR_OK
)
1439 gdb_put_packet(connection
, "OK", 2);
1444 watchpoint_remove(target
, address
);
1445 gdb_put_packet(connection
, "OK", 2);
1456 /* print out a string and allocate more space as needed, mainly used for XML at this point */
1457 void xml_printf(int *retval
, char **xml
, int *pos
, int *size
, const char *fmt
, ...)
1459 if (*retval
!= ERROR_OK
)
1467 if ((*xml
== NULL
) || (!first
))
1469 /* start by 0 to exercise all the code paths.
1470 * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1472 *size
= *size
* 2 + 2;
1474 *xml
= realloc(*xml
, *size
);
1479 *retval
= ERROR_SERVER_REMOTE_CLOSED
;
1487 ret
= vsnprintf(*xml
+ *pos
, *size
- *pos
, fmt
, ap
);
1489 if ((ret
> 0) && ((ret
+ 1) < *size
- *pos
))
1494 /* there was just enough or not enough space, allocate more. */
1499 static int decode_xfer_read(char *buf
, char **annex
, int *ofs
, unsigned int *len
)
1503 /* Extract and NUL-terminate the annex. */
1505 while (*buf
&& *buf
!= ':')
1511 /* After the read marker and annex, qXfer looks like a
1512 * traditional 'm' packet. */
1514 *ofs
= strtoul(buf
, &separator
, 16);
1516 if (*separator
!= ',')
1519 *len
= strtoul(separator
+ 1, NULL
, 16);
1524 int gdb_calc_blocksize(struct flash_bank
*bank
)
1527 uint32_t block_size
= 0xffffffff;
1529 /* loop through all sectors and return smallest sector size */
1531 for (i
= 0; i
< (uint32_t)bank
->num_sectors
; i
++)
1533 if (bank
->sectors
[i
].size
< block_size
)
1534 block_size
= bank
->sectors
[i
].size
;
1540 static int compare_bank (const void * a
, const void * b
)
1542 struct flash_bank
*b1
, *b2
;
1543 b1
=*((struct flash_bank
**)a
);
1544 b2
=*((struct flash_bank
**)b
);
1546 if (b1
->base
== b2
->base
)
1549 } else if (b1
->base
> b2
->base
)
1558 int gdb_query_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1560 struct command_context
*cmd_ctx
= connection
->cmd_ctx
;
1561 struct gdb_connection
*gdb_connection
= connection
->priv
;
1563 if (strstr(packet
, "qRcmd,"))
1565 if (packet_size
> 6)
1569 cmd
= malloc((packet_size
- 6)/2 + 1);
1570 for (i
= 0; i
< (packet_size
- 6)/2; i
++)
1573 sscanf(packet
+ 6 + 2*i
, "%2" SCNx32
, &tmp
);
1576 cmd
[(packet_size
- 6)/2] = 0x0;
1578 /* We want to print all debug output to GDB connection */
1579 log_add_callback(gdb_log_callback
, connection
);
1580 target_call_timer_callbacks_now();
1581 /* some commands need to know the GDB connection, make note of current
1582 * GDB connection. */
1583 current_gdb_connection
= gdb_connection
;
1584 command_run_line(cmd_ctx
, cmd
);
1585 current_gdb_connection
= NULL
;
1586 target_call_timer_callbacks_now();
1587 log_remove_callback(gdb_log_callback
, connection
);
1590 gdb_put_packet(connection
, "OK", 2);
1593 else if (strstr(packet
, "qCRC:"))
1595 if (packet_size
> 5)
1604 /* skip command character */
1607 addr
= strtoul(packet
, &separator
, 16);
1609 if (*separator
!= ',')
1611 LOG_ERROR("incomplete read memory packet received, dropping connection");
1612 return ERROR_SERVER_REMOTE_CLOSED
;
1615 len
= strtoul(separator
+ 1, NULL
, 16);
1617 retval
= target_checksum_memory(target
, addr
, len
, &checksum
);
1619 if (retval
== ERROR_OK
)
1621 snprintf(gdb_reply
, 10, "C%8.8" PRIx32
"", checksum
);
1622 gdb_put_packet(connection
, gdb_reply
, 9);
1626 if ((retval
= gdb_error(connection
, retval
)) != ERROR_OK
)
1633 else if (strstr(packet
, "qSupported"))
1635 /* we currently support packet size and qXfer:memory-map:read (if enabled)
1636 * disable qXfer:features:read for the moment */
1637 int retval
= ERROR_OK
;
1638 char *buffer
= NULL
;
1642 xml_printf(&retval
, &buffer
, &pos
, &size
,
1643 "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read-;QStartNoAckMode+",
1644 (GDB_BUFFER_SIZE
- 1), ((gdb_use_memory_map
== 1) && (flash_get_bank_count() > 0)) ? '+' : '-');
1646 if (retval
!= ERROR_OK
)
1648 gdb_send_error(connection
, 01);
1652 gdb_put_packet(connection
, buffer
, strlen(buffer
));
1657 else if (strstr(packet
, "qXfer:memory-map:read::") && (flash_get_bank_count() > 0))
1659 /* We get away with only specifying flash here. Regions that are not
1660 * specified are treated as if we provided no memory map(if not we
1661 * could detect the holes and mark them as RAM).
1662 * Normally we only execute this code once, but no big deal if we
1663 * have to regenerate it a couple of times. */
1665 struct flash_bank
*p
;
1669 int retval
= ERROR_OK
;
1676 /* skip command character */
1679 offset
= strtoul(packet
, &separator
, 16);
1680 length
= strtoul(separator
+ 1, &separator
, 16);
1682 xml_printf(&retval
, &xml
, &pos
, &size
, "<memory-map>\n");
1685 sort banks in ascending order, we need to make non-flash memory be ram(or rather
1686 read/write) by default for GDB.
1687 GDB does not have a concept of non-cacheable read/write memory.
1689 struct flash_bank
**banks
= malloc(sizeof(struct flash_bank
*)*flash_get_bank_count());
1692 for (i
= 0; i
< flash_get_bank_count(); i
++)
1694 p
= get_flash_bank_by_num(i
);
1698 retval
= ERROR_FAIL
;
1699 gdb_send_error(connection
, retval
);
1705 qsort(banks
, flash_get_bank_count(), sizeof(struct flash_bank
*), compare_bank
);
1707 uint32_t ram_start
= 0;
1708 for (i
= 0; i
< flash_get_bank_count(); i
++)
1712 if (ram_start
< p
->base
)
1714 xml_printf(&retval
, &xml
, &pos
, &size
, "<memory type=\"ram\" start=\"0x%x\" length=\"0x%x\"/>\n",
1715 ram_start
, p
->base
-ram_start
);
1718 /* if device has uneven sector sizes, eg. str7, lpc
1719 * we pass the smallest sector size to gdb memory map */
1720 blocksize
= gdb_calc_blocksize(p
);
1722 xml_printf(&retval
, &xml
, &pos
, &size
, "<memory type=\"flash\" start=\"0x%x\" length=\"0x%x\">\n" \
1723 "<property name=\"blocksize\">0x%x</property>\n" \
1725 p
->base
, p
->size
, blocksize
);
1726 ram_start
= p
->base
+ p
->size
;
1730 xml_printf(&retval
, &xml
, &pos
, &size
, "<memory type=\"ram\" start=\"0x%x\" length=\"0x%x\"/>\n",
1731 ram_start
, 0-ram_start
);
1734 /* a flash chip could be at the very end of the 32 bit address space, in which case
1735 ram_start will be precisely 0 */
1741 xml_printf(&retval
, &xml
, &pos
, &size
, "</memory-map>\n");
1743 if (retval
!= ERROR_OK
)
1745 gdb_send_error(connection
, retval
);
1749 if (offset
+ length
> pos
)
1751 length
= pos
- offset
;
1754 char *t
= malloc(length
+ 1);
1756 memcpy(t
+ 1, xml
+ offset
, length
);
1757 gdb_put_packet(connection
, t
, length
+ 1);
1763 else if (strstr(packet
, "qXfer:features:read:"))
1768 int retval
= ERROR_OK
;
1771 unsigned int length
;
1774 /* skip command character */
1777 if (decode_xfer_read(packet
, &annex
, &offset
, &length
) < 0)
1779 gdb_send_error(connection
, 01);
1783 if (strcmp(annex
, "target.xml") != 0)
1785 gdb_send_error(connection
, 01);
1789 xml_printf(&retval
, &xml
, &pos
, &size
, \
1790 "l < target version=\"1.0\">\n < architecture > arm</architecture>\n</target>\n");
1792 if (retval
!= ERROR_OK
)
1794 gdb_send_error(connection
, retval
);
1798 gdb_put_packet(connection
, xml
, strlen(xml
));
1803 else if (strstr(packet
, "QStartNoAckMode"))
1805 gdb_connection
->noack_mode
= 1;
1806 gdb_put_packet(connection
, "OK", 2);
1810 gdb_put_packet(connection
, "", 0);
1814 int gdb_v_packet(struct connection
*connection
, struct target
*target
, char *packet
, int packet_size
)
1816 struct gdb_connection
*gdb_connection
= connection
->priv
;
1817 struct gdb_service
*gdb_service
= connection
->service
->priv
;
1820 /* if flash programming disabled - send a empty reply */
1822 if (gdb_flash_program
== 0)
1824 gdb_put_packet(connection
, "", 0);
1828 if (strstr(packet
, "vFlashErase:"))
1831 unsigned long length
;
1833 char *parse
= packet
+ 12;
1836 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1837 return ERROR_SERVER_REMOTE_CLOSED
;
1840 addr
= strtoul(parse
, &parse
, 16);
1842 if (*(parse
++) != ',' || *parse
== '\0')
1844 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1845 return ERROR_SERVER_REMOTE_CLOSED
;
1848 length
= strtoul(parse
, &parse
, 16);
1852 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1853 return ERROR_SERVER_REMOTE_CLOSED
;
1856 /* assume all sectors need erasing - stops any problems
1857 * when flash_write is called multiple times */
1860 /* perform any target specific operations before the erase */
1861 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_FLASH_ERASE_START
);
1862 result
= flash_erase_address_range(gdb_service
->target
, addr
, length
);
1863 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_FLASH_ERASE_END
);
1866 if (result
!= ERROR_OK
)
1868 /* GDB doesn't evaluate the actual error number returned,
1869 * treat a failed erase as an I/O error
1871 gdb_send_error(connection
, EIO
);
1872 LOG_ERROR("flash_erase returned %i", result
);
1875 gdb_put_packet(connection
, "OK", 2);
1880 if (strstr(packet
, "vFlashWrite:"))
1884 unsigned long length
;
1885 char *parse
= packet
+ 12;
1889 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1890 return ERROR_SERVER_REMOTE_CLOSED
;
1892 addr
= strtoul(parse
, &parse
, 16);
1893 if (*(parse
++) != ':')
1895 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1896 return ERROR_SERVER_REMOTE_CLOSED
;
1898 length
= packet_size
- (parse
- packet
);
1900 /* create a new image if there isn't already one */
1901 if (gdb_connection
->vflash_image
== NULL
)
1903 gdb_connection
->vflash_image
= malloc(sizeof(struct image
));
1904 image_open(gdb_connection
->vflash_image
, "", "build");
1907 /* create new section with content from packet buffer */
1908 if ((retval
= image_add_section(gdb_connection
->vflash_image
, addr
, length
, 0x0, (uint8_t*)parse
)) != ERROR_OK
)
1913 gdb_put_packet(connection
, "OK", 2);
1918 if (!strcmp(packet
, "vFlashDone"))
1922 /* process the flashing buffer. No need to erase as GDB
1923 * always issues a vFlashErase first. */
1924 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_FLASH_WRITE_START
);
1925 result
= flash_write(gdb_service
->target
, gdb_connection
->vflash_image
, &written
, 0);
1926 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_FLASH_WRITE_END
);
1927 if (result
!= ERROR_OK
)
1929 if (result
== ERROR_FLASH_DST_OUT_OF_BANK
)
1930 gdb_put_packet(connection
, "E.memtype", 9);
1932 gdb_send_error(connection
, EIO
);
1936 LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written
);
1937 gdb_put_packet(connection
, "OK", 2);
1940 image_close(gdb_connection
->vflash_image
);
1941 free(gdb_connection
->vflash_image
);
1942 gdb_connection
->vflash_image
= NULL
;
1947 gdb_put_packet(connection
, "", 0);
1951 int gdb_detach(struct connection
*connection
, struct target
*target
)
1953 struct gdb_service
*gdb_service
= connection
->service
->priv
;
1955 target_call_event_callbacks(gdb_service
->target
, TARGET_EVENT_GDB_DETACH
);
1957 return gdb_put_packet(connection
, "OK", 2);
1960 static void gdb_log_callback(void *priv
, const char *file
, unsigned line
,
1961 const char *function
, const char *string
)
1963 struct connection
*connection
= priv
;
1964 struct gdb_connection
*gdb_con
= connection
->priv
;
1968 /* do not reply this using the O packet */
1972 gdb_output_con(connection
, string
);
1975 /* Do not allocate this on the stack */
1976 char gdb_packet_buffer
[GDB_BUFFER_SIZE
];
1978 static void gdb_sig_halted(struct connection
*connection
)
1981 snprintf(sig_reply
, 4, "T%2.2x", 2);
1982 gdb_put_packet(connection
, sig_reply
, 3);
1986 int gdb_input_inner(struct connection
*connection
)
1988 struct gdb_service
*gdb_service
= connection
->service
->priv
;
1989 struct target
*target
= gdb_service
->target
;
1990 char *packet
= gdb_packet_buffer
;
1993 struct gdb_connection
*gdb_con
= connection
->priv
;
1994 static int extended_protocol
= 0;
1996 /* drain input buffer */
1999 packet_size
= GDB_BUFFER_SIZE
-1;
2000 if ((retval
= gdb_get_packet(connection
, packet
, &packet_size
)) != ERROR_OK
)
2005 /* terminate with zero */
2006 packet
[packet_size
] = 0;
2008 if (LOG_LEVEL_IS(LOG_LVL_DEBUG
)) {
2009 if (packet
[0] == 'X') {
2010 // binary packets spew junk into the debug log stream
2013 for (x
= 0 ; (x
< 49) && (packet
[x
] != ':') ; x
++) {
2017 LOG_DEBUG("received packet: '%s:<binary-data>'", buf
);
2019 LOG_DEBUG("received packet: '%s'", packet
);
2023 if (packet_size
> 0)
2029 /* Hct... -- set thread
2030 * we don't have threads, send empty reply */
2031 gdb_put_packet(connection
, NULL
, 0);
2035 retval
= gdb_query_packet(connection
, target
, packet
, packet_size
);
2038 retval
= gdb_get_registers_packet(connection
, target
, packet
, packet_size
);
2041 retval
= gdb_set_registers_packet(connection
, target
, packet
, packet_size
);
2044 retval
= gdb_get_register_packet(connection
, target
, packet
, packet_size
);
2047 retval
= gdb_set_register_packet(connection
, target
, packet
, packet_size
);
2050 retval
= gdb_read_memory_packet(connection
, target
, packet
, packet_size
);
2053 retval
= gdb_write_memory_packet(connection
, target
, packet
, packet_size
);
2057 retval
= gdb_breakpoint_watchpoint_packet(connection
, target
, packet
, packet_size
);
2060 gdb_last_signal_packet(connection
, target
, packet
, packet_size
);
2065 int retval
= ERROR_OK
;
2067 struct gdb_connection
*gdb_con
= connection
->priv
;
2068 log_add_callback(gdb_log_callback
, connection
);
2070 bool nostep
= false;
2071 if (target
->state
== TARGET_RUNNING
)
2073 LOG_WARNING("The target is already running. Halt target before stepi/continue.");
2074 retval
= target_halt(target
);
2075 if (retval
== ERROR_OK
)
2076 retval
= target_wait_state(target
, TARGET_HALTED
, 100);
2077 } else if (target
->state
!= TARGET_HALTED
)
2079 LOG_WARNING("The target is not in the halted nor running stated, stepi/continue ignored.");
2081 } else if ((packet
[0] == 's') && gdb_con
->sync
)
2083 /* Hmm..... when you issue a continue in GDB, then a "stepi" is
2084 * sent by GDB first to OpenOCD, thus defeating the check to
2085 * make only the single stepping have the sync feature...
2088 LOG_WARNING("stepi ignored. GDB will now fetch the register state from the target.");
2090 gdb_con
->sync
= false;
2092 if ((retval
!=ERROR_OK
) || nostep
)
2094 /* Either the target isn't in the halted state, then we can't
2095 * step/continue. This might be early setup, etc.
2097 * Or we want to allow GDB to pick up a fresh set of
2098 * register values without modifying the target state.
2101 gdb_sig_halted(connection
);
2103 /* stop forwarding log packets! */
2104 log_remove_callback(gdb_log_callback
, connection
);
2107 /* We're running/stepping, in which case we can
2108 * forward log output until the target is halted
2110 gdb_con
->frontend_state
= TARGET_RUNNING
;
2111 target_call_event_callbacks(target
, TARGET_EVENT_GDB_START
);
2112 int retval
= gdb_step_continue_packet(connection
, target
, packet
, packet_size
);
2113 if (retval
!= ERROR_OK
)
2115 /* we'll never receive a halted condition... issue a false one.. */
2116 gdb_frontend_halted(target
, connection
);
2122 retval
= gdb_v_packet(connection
, target
, packet
, packet_size
);
2125 retval
= gdb_detach(connection
, target
);
2126 extended_protocol
= 0;
2129 if ((retval
= gdb_write_memory_binary_packet(connection
, target
, packet
, packet_size
)) != ERROR_OK
)
2133 if (extended_protocol
!= 0)
2135 gdb_put_packet(connection
, "OK", 2);
2136 return ERROR_SERVER_REMOTE_CLOSED
;
2138 /* handle extended remote protocol */
2139 extended_protocol
= 1;
2140 gdb_put_packet(connection
, "OK", 2);
2143 /* handle extended restart packet */
2144 breakpoint_clear_target(gdb_service
->target
);
2145 watchpoint_clear_target(gdb_service
->target
);
2146 command_run_linef(connection
->cmd_ctx
,
2147 "ocd_gdb_restart %s",
2151 /* ignore unkown packets */
2152 LOG_DEBUG("ignoring 0x%2.2x packet", packet
[0]);
2153 gdb_put_packet(connection
, NULL
, 0);
2157 /* if a packet handler returned an error, exit input loop */
2158 if (retval
!= ERROR_OK
)
2162 if (gdb_con
->ctrl_c
)
2164 if (target
->state
== TARGET_RUNNING
)
2166 retval
= target_halt(target
);
2167 if (retval
!= ERROR_OK
)
2169 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
2171 gdb_con
->ctrl_c
= 0;
2174 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
2175 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
2179 } while (gdb_con
->buf_cnt
> 0);
2184 int gdb_input(struct connection
*connection
)
2186 int retval
= gdb_input_inner(connection
);
2187 struct gdb_connection
*gdb_con
= connection
->priv
;
2188 if (retval
== ERROR_SERVER_REMOTE_CLOSED
)
2191 /* logging does not propagate the error, yet can set the gdb_con->closed flag */
2192 if (gdb_con
->closed
)
2193 return ERROR_SERVER_REMOTE_CLOSED
;
2195 /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
2201 struct gdb_service
*gdb_service
;
2202 struct target
*target
= all_targets
;
2206 LOG_WARNING("no gdb ports allocated as no target has been specified");
2210 if (gdb_port
== 0 && server_use_pipes
== 0)
2212 LOG_INFO("gdb port disabled");
2216 if (server_use_pipes
)
2218 /* only a single gdb connection when using a pipe */
2220 gdb_service
= malloc(sizeof(struct gdb_service
));
2221 gdb_service
->target
= target
;
2223 add_service("gdb", CONNECTION_PIPE
, 0, 1, gdb_new_connection
, gdb_input
, gdb_connection_closed
, gdb_service
);
2225 LOG_DEBUG("gdb service for target %s using pipes",
2226 target_get_name(target
));
2230 unsigned short port
= gdb_port
;
2234 gdb_service
= malloc(sizeof(struct gdb_service
));
2235 gdb_service
->target
= target
;
2237 add_service("gdb", CONNECTION_TCP
,
2239 gdb_new_connection
, gdb_input
,
2240 gdb_connection_closed
, gdb_service
);
2242 LOG_DEBUG("gdb service for target %s at TCP port %i",
2243 target_get_name(target
),
2245 target
= target
->next
;
2253 COMMAND_HANDLER(handle_gdb_sync_command
)
2257 return ERROR_COMMAND_SYNTAX_ERROR
;
2260 if (current_gdb_connection
== NULL
)
2262 command_print(cmd_ctx
,
2263 "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
2267 current_gdb_connection
->sync
= true;
2272 /* daemon configuration command gdb_port */
2273 COMMAND_HANDLER(handle_gdb_port_command
)
2275 return CALL_COMMAND_HANDLER(server_port_command
, &gdb_port
);
2278 COMMAND_HANDLER(handle_gdb_memory_map_command
)
2282 if (strcmp(args
[0], "enable") == 0)
2284 gdb_use_memory_map
= 1;
2287 else if (strcmp(args
[0], "disable") == 0)
2289 gdb_use_memory_map
= 0;
2293 LOG_WARNING("invalid gdb_memory_map configuration directive %s", args
[0]);
2296 return ERROR_COMMAND_SYNTAX_ERROR
;
2299 COMMAND_HANDLER(handle_gdb_flash_program_command
)
2303 if (strcmp(args
[0], "enable") == 0)
2305 gdb_flash_program
= 1;
2308 else if (strcmp(args
[0], "disable") == 0)
2310 gdb_flash_program
= 0;
2314 LOG_WARNING("invalid gdb_flash_program configuration directive: %s", args
[0]);
2317 return ERROR_COMMAND_SYNTAX_ERROR
;
2320 COMMAND_HANDLER(handle_gdb_report_data_abort_command
)
2324 if (strcmp(args
[0], "enable") == 0)
2326 gdb_report_data_abort
= 1;
2329 else if (strcmp(args
[0], "disable") == 0)
2331 gdb_report_data_abort
= 0;
2335 LOG_WARNING("invalid gdb_report_data_abort configuration directive: %s", args
[0]);
2338 return ERROR_COMMAND_SYNTAX_ERROR
;
2341 /* gdb_breakpoint_override */
2342 COMMAND_HANDLER(handle_gdb_breakpoint_override_command
)
2347 } else if (argc
== 1)
2349 gdb_breakpoint_override
= 1;
2350 if (strcmp(args
[0], "hard") == 0)
2352 gdb_breakpoint_override_type
= BKPT_HARD
;
2353 } else if (strcmp(args
[0], "soft") == 0)
2355 gdb_breakpoint_override_type
= BKPT_SOFT
;
2356 } else if (strcmp(args
[0], "disable") == 0)
2358 gdb_breakpoint_override
= 0;
2362 return ERROR_COMMAND_SYNTAX_ERROR
;
2364 if (gdb_breakpoint_override
)
2366 LOG_USER("force %s breakpoints", (gdb_breakpoint_override_type
== BKPT_HARD
)?"hard":"soft");
2369 LOG_USER("breakpoint type is not overriden");
2375 int gdb_register_commands(struct command_context
*command_context
)
2377 register_command(command_context
, NULL
, "gdb_sync",
2378 handle_gdb_sync_command
, COMMAND_ANY
,
2379 "next stepi will return immediately allowing GDB to "
2380 "fetch register state without affecting target state");
2381 register_command(command_context
, NULL
, "gdb_port",
2382 handle_gdb_port_command
, COMMAND_ANY
,
2383 "daemon configuration command gdb_port");
2384 register_command(command_context
, NULL
, "gdb_memory_map",
2385 handle_gdb_memory_map_command
, COMMAND_CONFIG
,
2386 "enable or disable memory map");
2387 register_command(command_context
, NULL
, "gdb_flash_program",
2388 handle_gdb_flash_program_command
, COMMAND_CONFIG
,
2389 "enable or disable flash program");
2390 register_command(command_context
, NULL
, "gdb_report_data_abort",
2391 handle_gdb_report_data_abort_command
, COMMAND_CONFIG
,
2392 "enable or disable reporting data aborts");
2393 register_command(command_context
, NULL
, "gdb_breakpoint_override",
2394 handle_gdb_breakpoint_override_command
, COMMAND_EXEC
,
2395 "hard/soft/disable - force type of breakpoint "
2396 "used by gdb 'break' commands.");
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)