* Copyright (C) 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
- * Copyright (C) 2007,2008 Øyvind Harboe *
+ * Copyright (C) 2007-2009 Øyvind Harboe *
* oyvind.harboe@zylin.com *
* *
* Copyright (C) 2008 by Spencer Oliver *
#include "config.h"
#endif
-#include "breakpoints.h"
-#include "target_request.h"
-#include "register.h"
+#include <target/breakpoints.h>
+#include <target/target_request.h>
+#include <target/register.h>
#include "server.h"
-#include "flash.h"
+#include <flash/nor/core.h>
#include "gdb_server.h"
-#include "image.h"
-#include "jtag.h"
+#include <target/image.h>
+#include <jtag/jtag.h>
+
+
+/**
+ * @file
+ * GDB server implementation.
+ *
+ * This implements the GDB Remote Serial Protocol, over TCP connections,
+ * giving GDB access to the JTAG or other hardware debugging facilities
+ * found in most modern embedded processors.
+ */
+
+/* private connection data for GDB */
+struct gdb_connection
+{
+ char buffer[GDB_BUFFER_SIZE];
+ char *buf_p;
+ int buf_cnt;
+ int ctrl_c;
+ enum target_state frontend_state;
+ struct image *vflash_image;
+ int closed;
+ int busy;
+ int noack_mode;
+ bool sync; /* set flag to true if you want the next stepi to return immediately.
+ allowing GDB to pick up a fresh set of register values from the target
+ without modifying the target state. */
+
+};
#if 0
extern int gdb_error(struct connection *connection, int retval);
static unsigned short gdb_port = 3333;
-static const char *DIGITS = "0123456789abcdef";
+static unsigned short gdb_port_next = 0;
+static const char DIGITS[16] = "0123456789abcdef";
static void gdb_log_callback(void *priv, const char *file, unsigned line,
const char *function, const char *string);
-/* number of gdb connections, mainly to supress gdb related debugging spam
+/* number of gdb connections, mainly to suppress gdb related debugging spam
* in helper/log.c when no gdb connections are actually active */
int gdb_actual_connections;
return ERROR_OK;
}
-int gdb_get_char(struct connection *connection, int* next_char)
+static int gdb_get_char_inner(struct connection *connection, int* next_char)
{
struct gdb_connection *gdb_con = connection->priv;
int retval = ERROR_OK;
-#ifdef _DEBUG_GDB_IO_
- char *debug_buffer;
-#endif
-
- if (gdb_con->buf_cnt-- > 0)
- {
- *next_char = *(gdb_con->buf_p++);
- if (gdb_con->buf_cnt > 0)
- connection->input_pending = 1;
- else
- connection->input_pending = 0;
-
-#ifdef _DEBUG_GDB_IO_
- LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
-#endif
-
- return ERROR_OK;
- }
-
for (;;)
{
if (connection->service->type == CONNECTION_PIPE)
return retval;
}
+/**
+ * The cool thing about this fn is that it allows buf_p and buf_cnt to be
+ * held in registers in the inner loop.
+ *
+ * For small caches and embedded systems this is important!
+ */
+static inline int gdb_get_char_fast(struct connection *connection, int* next_char, char **buf_p, int *buf_cnt)
+{
+ int retval = ERROR_OK;
+
+ if ((*buf_cnt)-- > 0)
+ {
+ *next_char = **buf_p;
+ (*buf_p)++;
+ if (*buf_cnt > 0)
+ connection->input_pending = 1;
+ else
+ connection->input_pending = 0;
+
+#ifdef _DEBUG_GDB_IO_
+ LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
+#endif
+
+ return ERROR_OK;
+ }
+
+ struct gdb_connection *gdb_con = connection->priv;
+ gdb_con->buf_p = *buf_p;
+ gdb_con->buf_cnt = *buf_cnt;
+ retval = gdb_get_char_inner(connection, next_char);
+ *buf_p = gdb_con->buf_p;
+ *buf_cnt = gdb_con->buf_cnt;
+
+ return retval;
+}
+
+
+int gdb_get_char(struct connection *connection, int* next_char)
+{
+ struct gdb_connection *gdb_con = connection->priv;
+ return gdb_get_char_fast(connection, next_char, &gdb_con->buf_p, &gdb_con->buf_cnt);
+}
+
+
int gdb_putback_char(struct connection *connection, int last_char)
{
struct gdb_connection *gdb_con = connection->priv;
unsigned char my_checksum = 0;
char checksum[3];
int character;
- int retval;
+ int retval = ERROR_OK;
struct gdb_connection *gdb_con = connection->priv;
my_checksum = 0;
int count = 0;
count = 0;
+
+ /* move this over into local variables to use registers and give the
+ * more freedom to optimize */
+ char *buf_p = gdb_con->buf_p;
+ int buf_cnt = gdb_con->buf_cnt;
+
for (;;)
{
/* The common case is that we have an entire packet with no escape chars.
* We need to leave at least 2 bytes in the buffer to have
* gdb_get_char() update various bits and bobs correctly.
*/
- if ((gdb_con->buf_cnt > 2) && ((gdb_con->buf_cnt + count) < *len))
+ if ((buf_cnt > 2) && ((buf_cnt + count) < *len))
{
/* The compiler will struggle a bit with constant propagation and
* aliasing, so we help it by showing that these values do not
* change inside the loop
*/
int i;
- char *buf = gdb_con->buf_p;
- int run = gdb_con->buf_cnt - 2;
+ char *buf = buf_p;
+ int run = buf_cnt - 2;
i = 0;
int done = 0;
while (i < run)
buffer[count++] = character & 0xff;
}
}
- gdb_con->buf_p += i;
- gdb_con->buf_cnt -= i;
+ buf_p += i;
+ buf_cnt -= i;
if (done)
break;
}
if (count > *len)
{
LOG_ERROR("packet buffer too small");
- return ERROR_GDB_BUFFER_TOO_SMALL;
+ retval = ERROR_GDB_BUFFER_TOO_SMALL;
+ break;
}
- if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
- return retval;
+ retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
+ if (retval != ERROR_OK)
+ break;
if (character == '#')
break;
/* data transmitted in binary mode (X packet)
* uses 0x7d as escape character */
my_checksum += character & 0xff;
- if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
- return retval;
+
+ retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
+ if (retval != ERROR_OK)
+ break;
+
my_checksum += character & 0xff;
buffer[count++] = (character ^ 0x20) & 0xff;
}
}
}
+ gdb_con->buf_p = buf_p;
+ gdb_con->buf_cnt = buf_cnt;
+
+ if (retval != ERROR_OK)
+ return retval;
+
*len = count;
if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
break;
case '+':
/* gdb sends a dummy ack '+' at every remote connect - see remote_start_remote (remote.c)
- * incase anyone tries to debug why they receive this warning every time */
+ * in case anyone tries to debug why they receive this warning every time */
LOG_WARNING("acknowledgment received, but no packet pending");
break;
case '-':
gdb_actual_connections++;
LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s",
gdb_actual_connections,
- gdb_service->target->cmd_name,
+ target_name(gdb_service->target),
target_state_name(gdb_service->target));
return ERROR_OK;
gdb_actual_connections--;
LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
- gdb_service->target->cmd_name,
+ target_name(gdb_service->target),
target_state_name(gdb_service->target),
gdb_actual_connections);
* register might be non-divisible by 8(a byte), in which
* case an entire byte is shown.
*
- * NB! the format on the wire is the target endianess
+ * NB! the format on the wire is the target endianness
*
* The format of reg->value is little endian
*
uint8_t *buf;
int buf_len;
buf = reg->value;
- buf_len = CEIL(reg->size, 8);
+ buf_len = DIV_ROUND_UP(reg->size, 8);
for (i = 0; i < buf_len; i++)
{
}
}
-static int hextoint(char c)
+static int hextoint(int c)
{
if (c>='0'&&c<='9')
{
reg_packet_size += reg_list[i]->size;
}
- reg_packet = malloc(CEIL(reg_packet_size, 8) * 2);
+ reg_packet = malloc(DIV_ROUND_UP(reg_packet_size, 8) * 2);
reg_packet_p = reg_packet;
for (i = 0; i < reg_list_size; i++)
{
gdb_str_to_target(target, reg_packet_p, reg_list[i]);
- reg_packet_p += CEIL(reg_list[i]->size, 8) * 2;
+ reg_packet_p += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
}
#ifdef _DEBUG_GDB_IO_
{
char *reg_packet_p;
- reg_packet_p = strndup(reg_packet, CEIL(reg_packet_size, 8) * 2);
+ reg_packet_p = strndup(reg_packet, DIV_ROUND_UP(reg_packet_size, 8) * 2);
LOG_DEBUG("reg_packet: %s", reg_packet_p);
free(reg_packet_p);
}
#endif
- gdb_put_packet(connection, reg_packet, CEIL(reg_packet_size, 8) * 2);
+ gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_packet_size, 8) * 2);
free(reg_packet);
free(reg_list);
for (i = 0; i < reg_list_size; i++)
{
uint8_t *bin_buf;
- int chars = (CEIL(reg_list[i]->size, 8) * 2);
+ int chars = (DIV_ROUND_UP(reg_list[i]->size, 8) * 2);
if (packet_p + chars > packet + packet_size)
{
LOG_ERROR("BUG: register packet is too small for registers");
}
- struct reg_arch_type *arch_type;
- bin_buf = malloc(CEIL(reg_list[i]->size, 8));
+ bin_buf = malloc(DIV_ROUND_UP(reg_list[i]->size, 8));
gdb_target_to_reg(target, packet_p, chars, bin_buf);
- /* get register arch_type, and call set method */
- arch_type = register_get_arch_type(reg_list[i]->arch_type);
-
- arch_type->set(reg_list[i], bin_buf);
+ reg_list[i]->type->set(reg_list[i], bin_buf);
/* advance packet pointer */
packet_p += chars;
exit(-1);
}
- reg_packet = malloc(CEIL(reg_list[reg_num]->size, 8) * 2);
+ reg_packet = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
gdb_str_to_target(target, reg_packet, reg_list[reg_num]);
- gdb_put_packet(connection, reg_packet, CEIL(reg_list[reg_num]->size, 8) * 2);
+ gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
free(reg_list);
free(reg_packet);
struct reg **reg_list;
int reg_list_size;
int retval;
- struct reg_arch_type *arch_type;
LOG_DEBUG("-");
}
/* convert from GDB-string (target-endian) to hex-string (big-endian) */
- bin_buf = malloc(CEIL(reg_list[reg_num]->size, 8));
- int chars = (CEIL(reg_list[reg_num]->size, 8) * 2);
+ bin_buf = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8));
+ int chars = (DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
/* fix!!! add some sanity checks on packet size here */
gdb_target_to_reg(target, separator + 1, chars, bin_buf);
- /* get register arch_type, and call set method */
- arch_type = register_get_arch_type(reg_list[reg_num]->arch_type);
- arch_type->set(reg_list[reg_num], bin_buf);
+ reg_list[reg_num]->type->set(reg_list[reg_num], bin_buf);
gdb_put_packet(connection, "OK", 2);
{
int type;
enum breakpoint_type bp_type = BKPT_SOFT /* dummy init to avoid warning */;
- enum watchpoint_rw wp_type;
+ enum watchpoint_rw wp_type = WPT_READ /* dummy init to avoid warning */;
uint32_t address;
uint32_t size;
char *separator;
wp_type = WPT_READ;
else if (type == 4) /* access watchpoint */
wp_type = WPT_ACCESS;
+ else
+ {
+ LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type);
+ return ERROR_SERVER_REMOTE_CLOSED;
+ }
+
if (gdb_breakpoint_override && ((bp_type == BKPT_SOFT)||(bp_type == BKPT_HARD)))
{
{
if (packet[0] == 'Z')
{
- if ((retval = watchpoint_add(target, address, size, type-2, 0, 0xffffffffu)) != ERROR_OK)
+ if ((retval = watchpoint_add(target, address, size, wp_type, 0, 0xffffffffu)) != ERROR_OK)
{
if ((retval = gdb_error(connection, retval)) != ERROR_OK)
return retval;
flash_set_dirty();
/* perform any target specific operations before the erase */
- target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_ERASE_START);
- result = flash_erase_address_range(gdb_service->target, addr, length);
- target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_ERASE_END);
+ target_call_event_callbacks(gdb_service->target,
+ TARGET_EVENT_GDB_FLASH_ERASE_START);
+
+ /* vFlashErase:addr,length messages require region start and
+ * end to be "block" aligned ... if padding is ever needed,
+ * GDB will have become dangerously confused.
+ */
+ result = flash_erase_address_range(gdb_service->target,
+ false, addr, length);
+
+ /* perform any target specific operations after the erase */
+ target_call_event_callbacks(gdb_service->target,
+ TARGET_EVENT_GDB_FLASH_ERASE_END);
/* perform erase */
if (result != ERROR_OK)
watchpoint_clear_target(gdb_service->target);
command_run_linef(connection->cmd_ctx,
"ocd_gdb_restart %s",
- target->cmd_name);
+ target_name(target));
break;
default:
- /* ignore unkown packets */
+ /* ignore unknown packets */
LOG_DEBUG("ignoring 0x%2.2x packet", packet[0]);
gdb_put_packet(connection, NULL, 0);
break;
return ERROR_OK;
}
-int gdb_init(void)
+static int gdb_target_start(struct target *target, uint16_t port)
{
- struct gdb_service *gdb_service;
- struct target *target = all_targets;
+ bool use_pipes = 0 == port;
+ struct gdb_service *gdb_service = malloc(sizeof(struct gdb_service));
+ if (NULL == gdb_service)
+ return -ENOMEM;
- if (!target)
- {
- LOG_WARNING("no gdb ports allocated as no target has been specified");
- return ERROR_OK;
- }
+ gdb_service->target = target;
+ add_service("gdb", use_pipes ? CONNECTION_PIPE : CONNECTION_TCP,
+ port, 1, &gdb_new_connection, &gdb_input,
+ &gdb_connection_closed, gdb_service);
+
+ const char *name = target_name(target);
+ if (use_pipes)
+ LOG_DEBUG("gdb service for target '%s' using pipes", name);
+ else
+ LOG_DEBUG("gdb service for target '%s' on TCP port %u", name, port);
+ return ERROR_OK;
+}
+
+/* FIXME static */
+int gdb_target_add_one(struct target *target)
+{
if (gdb_port == 0 && server_use_pipes == 0)
{
LOG_INFO("gdb port disabled");
return ERROR_OK;
}
+ if (0 == gdb_port_next)
+ gdb_port_next = gdb_port;
- if (server_use_pipes)
+ bool use_pipes = server_use_pipes;
+ static bool server_started_with_pipes = false;
+ if (server_started_with_pipes)
{
- /* only a single gdb connection when using a pipe */
+ LOG_WARNING("gdb service permits one target when using pipes");
+ if (0 == gdb_port)
+ return ERROR_OK;
- gdb_service = malloc(sizeof(struct gdb_service));
- gdb_service->target = target;
+ use_pipes = false;
+ }
- add_service("gdb", CONNECTION_PIPE, 0, 1, gdb_new_connection, gdb_input, gdb_connection_closed, gdb_service);
+ int e = gdb_target_start(target, use_pipes ? 0 : gdb_port_next);
+ if (ERROR_OK == e)
+ {
+ server_started_with_pipes |= use_pipes;
+ gdb_port_next++;
+ }
+ return e;
+}
- LOG_DEBUG("gdb service for target %s using pipes",
- target_get_name(target));
+int gdb_target_add_all(struct target *target)
+{
+ if (NULL == target)
+ {
+ LOG_WARNING("gdb services need one or more targets defined");
+ return ERROR_OK;
}
- else
+
+ while (NULL != target)
{
- unsigned short port = gdb_port;
+ int retval = gdb_target_add_one(target);
+ if (ERROR_OK != retval)
+ return retval;
- while (target)
- {
- gdb_service = malloc(sizeof(struct gdb_service));
- gdb_service->target = target;
-
- add_service("gdb", CONNECTION_TCP,
- port, 1,
- gdb_new_connection, gdb_input,
- gdb_connection_closed, gdb_service);
-
- LOG_DEBUG("gdb service for target %s at TCP port %i",
- target_get_name(target),
- port);
- target = target->next;
- port++;
- }
+ target = target->next;
}
return ERROR_OK;
COMMAND_HANDLER(handle_gdb_sync_command)
{
- if (argc != 0)
+ if (CMD_ARGC != 0)
{
return ERROR_COMMAND_SYNTAX_ERROR;
}
if (current_gdb_connection == NULL)
{
- command_print(cmd_ctx,
+ command_print(CMD_CTX,
"gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
return ERROR_FAIL;
}
/* daemon configuration command gdb_port */
COMMAND_HANDLER(handle_gdb_port_command)
{
- return CALL_COMMAND_HANDLER(server_port_command, &gdb_port);
+ int retval = CALL_COMMAND_HANDLER(server_port_command, &gdb_port);
+ if (ERROR_OK == retval)
+ gdb_port_next = gdb_port;
+ return retval;
}
COMMAND_HANDLER(handle_gdb_memory_map_command)
{
- if (argc == 1)
- {
- if (strcmp(args[0], "enable") == 0)
- {
- gdb_use_memory_map = 1;
- return ERROR_OK;
- }
- else if (strcmp(args[0], "disable") == 0)
- {
- gdb_use_memory_map = 0;
- return ERROR_OK;
- }
- else
- LOG_WARNING("invalid gdb_memory_map configuration directive %s", args[0]);
- }
+ if (CMD_ARGC == 1)
+ COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_memory_map);
return ERROR_COMMAND_SYNTAX_ERROR;
}
COMMAND_HANDLER(handle_gdb_flash_program_command)
{
- if (argc == 1)
- {
- if (strcmp(args[0], "enable") == 0)
- {
- gdb_flash_program = 1;
- return ERROR_OK;
- }
- else if (strcmp(args[0], "disable") == 0)
- {
- gdb_flash_program = 0;
- return ERROR_OK;
- }
- else
- LOG_WARNING("invalid gdb_flash_program configuration directive: %s", args[0]);
- }
+ if (CMD_ARGC == 1)
+ COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_flash_program);
return ERROR_COMMAND_SYNTAX_ERROR;
}
COMMAND_HANDLER(handle_gdb_report_data_abort_command)
{
- if (argc == 1)
- {
- if (strcmp(args[0], "enable") == 0)
- {
- gdb_report_data_abort = 1;
- return ERROR_OK;
- }
- else if (strcmp(args[0], "disable") == 0)
- {
- gdb_report_data_abort = 0;
- return ERROR_OK;
- }
- else
- LOG_WARNING("invalid gdb_report_data_abort configuration directive: %s", args[0]);
- }
+ if (CMD_ARGC == 1)
+ COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_data_abort);
return ERROR_COMMAND_SYNTAX_ERROR;
}
/* gdb_breakpoint_override */
COMMAND_HANDLER(handle_gdb_breakpoint_override_command)
{
- if (argc == 0)
+ if (CMD_ARGC == 0)
{
- } else if (argc == 1)
+ } else if (CMD_ARGC == 1)
{
gdb_breakpoint_override = 1;
- if (strcmp(args[0], "hard") == 0)
+ if (strcmp(CMD_ARGV[0], "hard") == 0)
{
gdb_breakpoint_override_type = BKPT_HARD;
- } else if (strcmp(args[0], "soft") == 0)
+ } else if (strcmp(CMD_ARGV[0], "soft") == 0)
{
gdb_breakpoint_override_type = BKPT_SOFT;
- } else if (strcmp(args[0], "disable") == 0)
+ } else if (strcmp(CMD_ARGV[0], "disable") == 0)
{
gdb_breakpoint_override = 0;
}
LOG_USER("force %s breakpoints", (gdb_breakpoint_override_type == BKPT_HARD)?"hard":"soft");
} else
{
- LOG_USER("breakpoint type is not overriden");
+ LOG_USER("breakpoint type is not overridden");
}
return ERROR_OK;
}
-int gdb_register_commands(struct command_context *command_context)
+static const struct command_registration gdb_command_handlers[] = {
+ {
+ .name = "gdb_sync",
+ .handler = handle_gdb_sync_command,
+ .mode = COMMAND_ANY,
+ .help = "next stepi will return immediately allowing "
+ "GDB to fetch register state without affecting "
+ "target state",
+ },
+ {
+ .name = "gdb_port",
+ .handler = handle_gdb_port_command,
+ .mode = COMMAND_ANY,
+ .help = "Display or specify base port on which to listen "
+ "for incoming GDB connections. "
+ "No arguments reports GDB port; zero disables.",
+ .usage = "[port_num]",
+ },
+ {
+ .name = "gdb_memory_map",
+ .handler = handle_gdb_memory_map_command,
+ .mode = COMMAND_CONFIG,
+ .help = "enable or disable memory map",
+ .usage = "('enable'|'disable')"
+ },
+ {
+ .name = "gdb_flash_program",
+ .handler = handle_gdb_flash_program_command,
+ .mode = COMMAND_CONFIG,
+ .help = "enable or disable flash program",
+ .usage = "('enable'|'disable')"
+ },
+ {
+ .name = "gdb_report_data_abort",
+ .handler = handle_gdb_report_data_abort_command,
+ .mode = COMMAND_CONFIG,
+ .help = "enable or disable reporting data aborts",
+ .usage = "('enable'|'disable')"
+ },
+ {
+ .name = "gdb_breakpoint_override",
+ .handler = handle_gdb_breakpoint_override_command,
+ .mode = COMMAND_ANY,
+ .help = "Display or specify type of breakpoint "
+ "to be used by gdb 'break' commands.",
+ .usage = "('hard'|'soft'|'disable')"
+ },
+ COMMAND_REGISTRATION_DONE
+};
+
+int gdb_register_commands(struct command_context *cmd_ctx)
{
- register_command(command_context, NULL, "gdb_sync",
- handle_gdb_sync_command, COMMAND_ANY,
- "next stepi will return immediately allowing GDB to "
- "fetch register state without affecting target state");
- register_command(command_context, NULL, "gdb_port",
- handle_gdb_port_command, COMMAND_ANY,
- "daemon configuration command gdb_port");
- register_command(command_context, NULL, "gdb_memory_map",
- handle_gdb_memory_map_command, COMMAND_CONFIG,
- "enable or disable memory map");
- register_command(command_context, NULL, "gdb_flash_program",
- handle_gdb_flash_program_command, COMMAND_CONFIG,
- "enable or disable flash program");
- register_command(command_context, NULL, "gdb_report_data_abort",
- handle_gdb_report_data_abort_command, COMMAND_CONFIG,
- "enable or disable reporting data aborts");
- register_command(command_context, NULL, "gdb_breakpoint_override",
- handle_gdb_breakpoint_override_command, COMMAND_EXEC,
- "hard/soft/disable - force type of breakpoint "
- "used by gdb 'break' commands.");
- return ERROR_OK;
+ return register_commands(cmd_ctx, NULL, gdb_command_handlers);
}
projects / fw / openocd / blobdiff