git.gag.com Git - fw/openocd/blob - src/server/gdb_server.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  11  *   Copyright (C) 2011 by Broadcom Corporation                            *
  12  *   Evan Hunter - ehunter@broadcom.com                                    *
  13  *                                                                         *
  14  *   Copyright (C) ST-Ericsson SA 2011                                     *
  15  *   michel.jaouen@stericsson.com : smp minimum support                    *
  16  *                                                                         *
  17  *   This program is free software; you can redistribute it and/or modify  *
  18  *   it under the terms of the GNU General Public License as published by  *
  19  *   the Free Software Foundation; either version 2 of the License, or     *
  20  *   (at your option) any later version.                                   *
  21  *                                                                         *
  22  *   This program is distributed in the hope that it will be useful,       *
  23  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  24  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  25  *   GNU General Public License for more details.                          *
  26  *                                                                         *
  27  *   You should have received a copy of the GNU General Public License     *
  28  *   along with this program; if not, write to the                         *
  29  *   Free Software Foundation, Inc.,                                       *
  30  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  31  ***************************************************************************/
  32 #ifdef HAVE_CONFIG_H
  33 #include "config.h"
  34 #endif
  35
  36 #include <target/breakpoints.h>
  37 #include <target/target_request.h>
  38 #include <target/register.h>
  39 #include "server.h"
  40 #include <flash/nor/core.h>
  41 #include "gdb_server.h"
  42 #include <target/image.h>
  43 #include <jtag/jtag.h>
  44 #include "rtos/rtos.h"
  45 #include "target/smp.h"
  46
  47
  48 /**
  49  * @file
  50  * GDB server implementation.
  51  *
  52  * This implements the GDB Remote Serial Protocol, over TCP connections,
  53  * giving GDB access to the JTAG or other hardware debugging facilities
  54  * found in most modern embedded processors.
  55  */
  56
  57 /* private connection data for GDB */
  58 struct gdb_connection
  59 {
  60         char buffer[GDB_BUFFER_SIZE];
  61         char *buf_p;
  62         int buf_cnt;
  63         int ctrl_c;
  64         enum target_state frontend_state;
  65         struct image *vflash_image;
  66         int closed;
  67         int busy;
  68         int noack_mode;
  69         bool sync;      /* set flag to true if you want the next stepi to return immediately.
  70                        allowing GDB to pick up a fresh set of register values from the target
  71                        without modifying the target state. */
  72         /* We delay reporting memory write errors until next step/continue or memory
  73          * write. This improves performance of gdb load significantly as the GDB packet
  74          * can be replied immediately and a new GDB packet will be ready without delay
  75          * (ca. 10% or so...).
  76          */
  77         bool mem_write_error;
  78 };
  79
  80
  81 #if 0
  82 #define _DEBUG_GDB_IO_
  83 #endif
  84
  85 static struct gdb_connection *current_gdb_connection;
  86
  87 static int gdb_breakpoint_override;
  88 static enum breakpoint_type gdb_breakpoint_override_type;
  89
  90 static int gdb_error(struct connection *connection, int retval);
  91 static const char *gdb_port;
  92 static const char *gdb_port_next;
  93 static const char DIGITS[16] = "0123456789abcdef";
  94
  95 static void gdb_log_callback(void *priv, const char *file, unsigned line,
  96                 const char *function, const char *string);
  97
  98 /* number of gdb connections, mainly to suppress gdb related debugging spam
  99  * in helper/log.c when no gdb connections are actually active */
 100 int gdb_actual_connections;
 101
 102 /* set if we are sending a memory map to gdb
 103  * via qXfer:memory-map:read packet */
 104 /* enabled by default*/
 105 static int gdb_use_memory_map = 1;
 106 /* enabled by default*/
 107 static int gdb_flash_program = 1;
 108
 109 /* if set, data aborts cause an error to be reported in memory read packets
 110  * see the code in gdb_read_memory_packet() for further explanations.
 111  * Disabled by default.
 112  */
 113 static int gdb_report_data_abort;
 114
 115 static int gdb_last_signal(struct target *target)
 116 {
 117         switch (target->debug_reason)
 118         {
 119                 case DBG_REASON_DBGRQ:
 120                         return 0x2; /* SIGINT */
 121                 case DBG_REASON_BREAKPOINT:
 122                 case DBG_REASON_WATCHPOINT:
 123                 case DBG_REASON_WPTANDBKPT:
 124                         return 0x05; /* SIGTRAP */
 125                 case DBG_REASON_SINGLESTEP:
 126                         return 0x05; /* SIGTRAP */
 127                 case DBG_REASON_NOTHALTED:
 128                         return 0x0; /* no signal... shouldn't happen */
 129                 default:
 130                         LOG_USER("undefined debug reason %d - target needs reset", target->debug_reason);
 131                         return 0x0;
 132         }
 133 }
 134
 135 static int check_pending(struct connection *connection,
 136                 int timeout_s, int *got_data)
 137 {
 138         /* a non-blocking socket will block if there is 0 bytes available on the socket,
 139          * but return with as many bytes as are available immediately
 140          */
 141         struct timeval tv;
 142         fd_set read_fds;
 143         struct gdb_connection *gdb_con = connection->priv;
 144         int t;
 145         if (got_data == NULL)
 146                 got_data=&t;
 147         *got_data = 0;
 148
 149         if (gdb_con->buf_cnt > 0)
 150         {
 151                 *got_data = 1;
 152                 return ERROR_OK;
 153         }
 154
 155         FD_ZERO(&read_fds);
 156         FD_SET(connection->fd, &read_fds);
 157
 158         tv.tv_sec = timeout_s;
 159         tv.tv_usec = 0;
 160         if (socket_select(connection->fd + 1, &read_fds, NULL, NULL, &tv) == 0)
 161         {
 162                 /* This can typically be because a "monitor" command took too long
 163                  * before printing any progress messages
 164                  */
 165                 if (timeout_s > 0)
 166                 {
 167                         return ERROR_GDB_TIMEOUT;
 168                 } else
 169                 {
 170                         return ERROR_OK;
 171                 }
 172         }
 173         *got_data = FD_ISSET(connection->fd, &read_fds) != 0;
 174         return ERROR_OK;
 175 }
 176
 177 static int gdb_get_char_inner(struct connection *connection, int* next_char)
 178 {
 179         struct gdb_connection *gdb_con = connection->priv;
 180         int retval = ERROR_OK;
 181
 182 #ifdef _DEBUG_GDB_IO_
 183         char *debug_buffer;
 184 #endif
 185         for (;;)
 186         {
 187                 if (connection->service->type != CONNECTION_TCP)
 188                 {
 189                         gdb_con->buf_cnt = read(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE);
 190                 }
 191                 else
 192                 {
 193                         retval = check_pending(connection, 1, NULL);
 194                         if (retval != ERROR_OK)
 195                                 return retval;
 196                         gdb_con->buf_cnt = read_socket(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE);
 197                 }
 198
 199                 if (gdb_con->buf_cnt > 0)
 200                 {
 201                         break;
 202                 }
 203                 if (gdb_con->buf_cnt == 0)
 204                 {
 205                         gdb_con->closed = 1;
 206                         return ERROR_SERVER_REMOTE_CLOSED;
 207                 }
 208
 209 #ifdef _WIN32
 210                 errno = WSAGetLastError();
 211
 212                 switch (errno)
 213                 {
 214                         case WSAEWOULDBLOCK:
 215                                 usleep(1000);
 216                                 break;
 217                         case WSAECONNABORTED:
 218                                 gdb_con->closed = 1;
 219                                 return ERROR_SERVER_REMOTE_CLOSED;
 220                         case WSAECONNRESET:
 221                                 gdb_con->closed = 1;
 222                                 return ERROR_SERVER_REMOTE_CLOSED;
 223                         default:
 224                                 LOG_ERROR("read: %d", errno);
 225                                 exit(-1);
 226                 }
 227 #else
 228                 switch (errno)
 229                 {
 230                         case EAGAIN:
 231                                 usleep(1000);
 232                                 break;
 233                         case ECONNABORTED:
 234                                 gdb_con->closed = 1;
 235                                 return ERROR_SERVER_REMOTE_CLOSED;
 236                         case ECONNRESET:
 237                                 gdb_con->closed = 1;
 238                                 return ERROR_SERVER_REMOTE_CLOSED;
 239                         default:
 240                                 LOG_ERROR("read: %s", strerror(errno));
 241                                 gdb_con->closed = 1;
 242                                 return ERROR_SERVER_REMOTE_CLOSED;
 243                 }
 244 #endif
 245         }
 246
 247 #ifdef _DEBUG_GDB_IO_
 248         debug_buffer = malloc(gdb_con->buf_cnt + 1);
 249         memcpy(debug_buffer, gdb_con->buffer, gdb_con->buf_cnt);
 250         debug_buffer[gdb_con->buf_cnt] = 0;
 251         LOG_DEBUG("received '%s'", debug_buffer);
 252         free(debug_buffer);
 253 #endif
 254
 255         gdb_con->buf_p = gdb_con->buffer;
 256         gdb_con->buf_cnt--;
 257         *next_char = *(gdb_con->buf_p++);
 258         if (gdb_con->buf_cnt > 0)
 259                 connection->input_pending = 1;
 260         else
 261                 connection->input_pending = 0;
 262 #ifdef _DEBUG_GDB_IO_
 263         LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
 264 #endif
 265
 266         return retval;
 267 }
 268
 269 /**
 270  * The cool thing about this fn is that it allows buf_p and buf_cnt to be
 271  * held in registers in the inner loop.
 272  *
 273  * For small caches and embedded systems this is important!
 274  */
 275 static inline int gdb_get_char_fast(struct connection *connection, int* next_char, char **buf_p, int *buf_cnt)
 276 {
 277         int retval = ERROR_OK;
 278
 279         if ((*buf_cnt)-- > 0)
 280         {
 281                 *next_char = **buf_p;
 282                 (*buf_p)++;
 283                 if (*buf_cnt > 0)
 284                         connection->input_pending = 1;
 285                 else
 286                         connection->input_pending = 0;
 287
 288 #ifdef _DEBUG_GDB_IO_
 289                 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
 290 #endif
 291
 292                 return ERROR_OK;
 293         }
 294
 295         struct gdb_connection *gdb_con = connection->priv;
 296         gdb_con->buf_p = *buf_p;
 297         gdb_con->buf_cnt = *buf_cnt;
 298         retval = gdb_get_char_inner(connection, next_char);
 299         *buf_p = gdb_con->buf_p;
 300         *buf_cnt = gdb_con->buf_cnt;
 301
 302         return retval;
 303 }
 304
 305
 306 static int gdb_get_char(struct connection *connection, int* next_char)
 307 {
 308         struct gdb_connection *gdb_con = connection->priv;
 309         return gdb_get_char_fast(connection, next_char, &gdb_con->buf_p, &gdb_con->buf_cnt);
 310 }
 311
 312
 313 static int gdb_putback_char(struct connection *connection, int last_char)
 314 {
 315         struct gdb_connection *gdb_con = connection->priv;
 316
 317         if (gdb_con->buf_p > gdb_con->buffer)
 318         {
 319                 *(--gdb_con->buf_p) = last_char;
 320                 gdb_con->buf_cnt++;
 321         }
 322         else
 323         {
 324                 LOG_ERROR("BUG: couldn't put character back");
 325         }
 326
 327         return ERROR_OK;
 328 }
 329
 330 /* The only way we can detect that the socket is closed is the first time
 331  * we write to it, we will fail. Subsequent write operations will
 332  * succeed. Shudder! */
 333 static int gdb_write(struct connection *connection, void *data, int len)
 334 {
 335         struct gdb_connection *gdb_con = connection->priv;
 336         if (gdb_con->closed)
 337                 return ERROR_SERVER_REMOTE_CLOSED;
 338
 339         if (connection_write(connection, data, len) == len)
 340         {
 341                 return ERROR_OK;
 342         }
 343         gdb_con->closed = 1;
 344         return ERROR_SERVER_REMOTE_CLOSED;
 345 }
 346
 347 static int gdb_put_packet_inner(struct connection *connection,
 348                 char *buffer, int len)
 349 {
 350         int i;
 351         unsigned char my_checksum = 0;
 352 #ifdef _DEBUG_GDB_IO_
 353         char *debug_buffer;
 354 #endif
 355         int reply;
 356         int retval;
 357         struct gdb_connection *gdb_con = connection->priv;
 358
 359         for (i = 0; i < len; i++)
 360                 my_checksum += buffer[i];
 361
 362 #ifdef _DEBUG_GDB_IO_
 363         /*
 364          * At this point we should have nothing in the input queue from GDB,
 365          * however sometimes '-' is sent even though we've already received
 366          * an ACK (+) for everything we've sent off.
 367          */
 368         int gotdata;
 369         for (;;)
 370         {
 371                 retval = check_pending(connection, 0, &gotdata);
 372                 if (retval != ERROR_OK)
 373                         return retval;
 374                 if (!gotdata)
 375                         break;
 376                 if ((retval = gdb_get_char(connection, &reply)) != ERROR_OK)
 377                         return retval;
 378                 if (reply == '$') {
 379                         /* fix a problem with some IAR tools */
 380                         gdb_putback_char(connection, reply);
 381                         LOG_DEBUG("Unexpected start of new packet");
 382                         break;
 383                 }
 384
 385                 LOG_WARNING("Discard unexpected char %c", reply);
 386         }
 387 #endif
 388
 389         while (1)
 390         {
 391 #ifdef _DEBUG_GDB_IO_
 392                 debug_buffer = malloc(len + 1);
 393                 memcpy(debug_buffer, buffer, len);
 394                 debug_buffer[len] = 0;
 395                 LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer, my_checksum);
 396                 free(debug_buffer);
 397 #endif
 398
 399                 char local_buffer[1024];
 400                 local_buffer[0] = '$';
 401                 if ((size_t)len + 4 <= sizeof(local_buffer))
 402                 {
 403                         /* performance gain on smaller packets by only a single call to gdb_write() */
 404                         memcpy(local_buffer + 1, buffer, len++);
 405                         local_buffer[len++] = '#';
 406                         local_buffer[len++] = DIGITS[(my_checksum >> 4) & 0xf];
 407                         local_buffer[len++] = DIGITS[my_checksum & 0xf];
 408                         if ((retval = gdb_write(connection, local_buffer, len)) != ERROR_OK)
 409                         {
 410                                 return retval;
 411                         }
 412                 }
 413                 else
 414                 {
 415                         /* larger packets are transmitted directly from caller supplied buffer
 416                            by several calls to gdb_write() to avoid dynamic allocation */
 417                         local_buffer[1] = '#';
 418                         local_buffer[2] = DIGITS[(my_checksum >> 4) & 0xf];
 419                         local_buffer[3] = DIGITS[my_checksum & 0xf];
 420                         if ((retval = gdb_write(connection, local_buffer, 1)) != ERROR_OK)
 421                         {
 422                                 return retval;
 423                         }
 424                         if ((retval = gdb_write(connection, buffer, len)) != ERROR_OK)
 425                         {
 426                                 return retval;
 427                         }
 428                         if ((retval = gdb_write(connection, local_buffer + 1, 3)) != ERROR_OK)
 429                         {
 430                                 return retval;
 431                         }
 432                 }
 433
 434                 if (gdb_con->noack_mode)
 435                         break;
 436
 437                 if ((retval = gdb_get_char(connection, &reply)) != ERROR_OK)
 438                         return retval;
 439
 440                 if (reply == '+')
 441                         break;
 442                 else if (reply == '-')
 443                 {
 444                         /* Stop sending output packets for now */
 445                         log_remove_callback(gdb_log_callback, connection);
 446                         LOG_WARNING("negative reply, retrying");
 447                 }
 448                 else if (reply == 0x3)
 449                 {
 450                         gdb_con->ctrl_c = 1;
 451                         if ((retval = gdb_get_char(connection, &reply)) != ERROR_OK)
 452                                 return retval;
 453                         if (reply == '+')
 454                                 break;
 455                         else if (reply == '-')
 456                         {
 457                                 /* Stop sending output packets for now */
 458                                 log_remove_callback(gdb_log_callback, connection);
 459                                 LOG_WARNING("negative reply, retrying");
 460                         }
 461                         else if (reply == '$') {
 462                                 LOG_ERROR("GDB missing ack(1) - assumed good");
 463                                 gdb_putback_char(connection, reply);
 464                                 return ERROR_OK;
 465                         } else {
 466
 467                                 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply);
 468                                 gdb_con->closed = 1;
 469                                 return ERROR_SERVER_REMOTE_CLOSED;
 470                         }
 471                 }
 472                 else if (reply == '$') {
 473                         LOG_ERROR("GDB missing ack(2) - assumed good");
 474                         gdb_putback_char(connection, reply);
 475                         return ERROR_OK;
 476                 }
 477                 else
 478                 {
 479                         LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection", reply);
 480                         gdb_con->closed = 1;
 481                         return ERROR_SERVER_REMOTE_CLOSED;
 482                 }
 483         }
 484         if (gdb_con->closed)
 485                 return ERROR_SERVER_REMOTE_CLOSED;
 486
 487         return ERROR_OK;
 488 }
 489
 490 int gdb_put_packet(struct connection *connection, char *buffer, int len)
 491 {
 492         struct gdb_connection *gdb_con = connection->priv;
 493         gdb_con->busy = 1;
 494         int retval = gdb_put_packet_inner(connection, buffer, len);
 495         gdb_con->busy = 0;
 496
 497         /* we sent some data, reset timer for keep alive messages */
 498         kept_alive();
 499
 500         return retval;
 501 }
 502
 503 static __inline__ int fetch_packet(struct connection *connection, int *checksum_ok, int noack, int *len, char *buffer)
 504 {
 505         unsigned char my_checksum = 0;
 506         char checksum[3];
 507         int character;
 508         int retval = ERROR_OK;
 509
 510         struct gdb_connection *gdb_con = connection->priv;
 511         my_checksum = 0;
 512         int count = 0;
 513         count = 0;
 514
 515         /* move this over into local variables to use registers and give the
 516          * more freedom to optimize */
 517         char *buf_p = gdb_con->buf_p;
 518         int buf_cnt = gdb_con->buf_cnt;
 519
 520         for (;;)
 521         {
 522                 /* The common case is that we have an entire packet with no escape chars.
 523                  * We need to leave at least 2 bytes in the buffer to have
 524                  * gdb_get_char() update various bits and bobs correctly.
 525                  */
 526                 if ((buf_cnt > 2) && ((buf_cnt + count) < *len))
 527                 {
 528                         /* The compiler will struggle a bit with constant propagation and
 529                          * aliasing, so we help it by showing that these values do not
 530                          * change inside the loop
 531                          */
 532                         int i;
 533                         char *buf = buf_p;
 534                         int run = buf_cnt - 2;
 535                         i = 0;
 536                         int done = 0;
 537                         while (i < run)
 538                         {
 539                                 character = *buf++;
 540                                 i++;
 541                                 if (character == '#')
 542                                 {
 543                                         /* Danger! character can be '#' when esc is
 544                                          * used so we need an explicit boolean for done here.
 545                                          */
 546                                         done = 1;
 547                                         break;
 548                                 }
 549
 550                                 if (character == '}')
 551                                 {
 552                                         /* data transmitted in binary mode (X packet)
 553                                          * uses 0x7d as escape character */
 554                                         my_checksum += character & 0xff;
 555                                         character = *buf++;
 556                                         i++;
 557                                         my_checksum += character & 0xff;
 558                                         buffer[count++] = (character ^ 0x20) & 0xff;
 559                                 }
 560                                 else
 561                                 {
 562                                         my_checksum += character & 0xff;
 563                                         buffer[count++] = character & 0xff;
 564                                 }
 565                         }
 566                         buf_p += i;
 567                         buf_cnt -= i;
 568                         if (done)
 569                                 break;
 570                 }
 571                 if (count > *len)
 572                 {
 573                         LOG_ERROR("packet buffer too small");
 574                         retval = ERROR_GDB_BUFFER_TOO_SMALL;
 575                         break;
 576                 }
 577
 578                 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
 579                 if (retval != ERROR_OK)
 580                         break;
 581
 582                 if (character == '#')
 583                         break;
 584
 585                 if (character == '}')
 586                 {
 587                         /* data transmitted in binary mode (X packet)
 588                          * uses 0x7d as escape character */
 589                         my_checksum += character & 0xff;
 590
 591                         retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
 592                         if (retval != ERROR_OK)
 593                                 break;
 594
 595                         my_checksum += character & 0xff;
 596                         buffer[count++] = (character ^ 0x20) & 0xff;
 597                 }
 598                 else
 599                 {
 600                         my_checksum += character & 0xff;
 601                         buffer[count++] = character & 0xff;
 602                 }
 603         }
 604
 605         gdb_con->buf_p = buf_p;
 606         gdb_con->buf_cnt = buf_cnt;
 607
 608         if (retval != ERROR_OK)
 609                 return retval;
 610
 611         *len = count;
 612
 613         if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
 614                 return retval;
 615         checksum[0] = character;
 616         if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
 617                 return retval;
 618         checksum[1] = character;
 619         checksum[2] = 0;
 620
 621         if (!noack)
 622         {
 623                 *checksum_ok = (my_checksum == strtoul(checksum, NULL, 16));
 624         }
 625
 626         return ERROR_OK;
 627 }
 628
 629 static int gdb_get_packet_inner(struct connection *connection,
 630                 char *buffer, int *len)
 631 {
 632         int character;
 633         int retval;
 634         struct gdb_connection *gdb_con = connection->priv;
 635
 636         while (1)
 637         {
 638                 do
 639                 {
 640                         if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
 641                                 return retval;
 642
 643 #ifdef _DEBUG_GDB_IO_
 644                         LOG_DEBUG("character: '%c'", character);
 645 #endif
 646
 647                         switch (character)
 648                         {
 649                                 case '$':
 650                                         break;
 651                                 case '+':
 652                                         /* gdb sends a dummy ack '+' at every remote connect - see remote_start_remote (remote.c)
 653                                          * in case anyone tries to debug why they receive this warning every time */
 654                                         LOG_WARNING("acknowledgment received, but no packet pending");
 655                                         break;
 656                                 case '-':
 657                                         LOG_WARNING("negative acknowledgment, but no packet pending");
 658                                         break;
 659                                 case 0x3:
 660                                         gdb_con->ctrl_c = 1;
 661                                         *len = 0;
 662                                         return ERROR_OK;
 663                                 default:
 664                                         LOG_WARNING("ignoring character 0x%x", character);
 665                                         break;
 666                         }
 667                 } while (character != '$');
 668
 669
 670
 671                 int checksum_ok = 0;
 672                 /* explicit code expansion here to get faster inlined code in -O3 by not
 673                  * calculating checksum
 674                  */
 675                 if (gdb_con->noack_mode)
 676                 {
 677                         if ((retval = fetch_packet(connection, &checksum_ok, 1, len, buffer)) != ERROR_OK)
 678                                 return retval;
 679                 } else
 680                 {
 681                         if ((retval = fetch_packet(connection, &checksum_ok, 0, len, buffer)) != ERROR_OK)
 682                                 return retval;
 683                 }
 684
 685                 if (gdb_con->noack_mode)
 686                 {
 687                         /* checksum is not checked in noack mode */
 688                         break;
 689                 }
 690                 if (checksum_ok)
 691                 {
 692                         if ((retval = gdb_write(connection, "+", 1)) != ERROR_OK)
 693                         {
 694                                 return retval;
 695                         }
 696                         break;
 697                 }
 698         }
 699         if (gdb_con->closed)
 700                 return ERROR_SERVER_REMOTE_CLOSED;
 701
 702         return ERROR_OK;
 703 }
 704
 705 static int gdb_get_packet(struct connection *connection, char *buffer, int *len)
 706 {
 707         struct gdb_connection *gdb_con = connection->priv;
 708         gdb_con->busy = 1;
 709         int retval = gdb_get_packet_inner(connection, buffer, len);
 710         gdb_con->busy = 0;
 711         return retval;
 712 }
 713
 714 static int gdb_output_con(struct connection *connection, const char* line)
 715 {
 716         char *hex_buffer;
 717         int i, bin_size;
 718
 719         bin_size = strlen(line);
 720
 721         hex_buffer = malloc(bin_size*2 + 2);
 722         if (hex_buffer == NULL)
 723                 return ERROR_GDB_BUFFER_TOO_SMALL;
 724
 725         hex_buffer[0] = 'O';
 726         for (i = 0; i < bin_size; i++)
 727                 snprintf(hex_buffer + 1 + i*2, 3, "%2.2x", line[i]);
 728         hex_buffer[bin_size*2 + 1] = 0;
 729
 730         int retval = gdb_put_packet(connection, hex_buffer, bin_size*2 + 1);
 731
 732         free(hex_buffer);
 733         return retval;
 734 }
 735
 736 static int gdb_output(struct command_context *context, const char* line)
 737 {
 738         /* this will be dumped to the log and also sent as an O packet if possible */
 739         LOG_USER_N("%s", line);
 740         return ERROR_OK;
 741 }
 742
 743
 744 static void gdb_frontend_halted(struct target *target, struct connection *connection)
 745 {
 746         struct gdb_connection *gdb_connection = connection->priv;
 747
 748         /* In the GDB protocol when we are stepping or continuing execution,
 749          * we have a lingering reply. Upon receiving a halted event
 750          * when we have that lingering packet, we reply to the original
 751          * step or continue packet.
 752          *
 753          * Executing monitor commands can bring the target in and
 754          * out of the running state so we'll see lots of TARGET_EVENT_XXX
 755          * that are to be ignored.
 756          */
 757         if (gdb_connection->frontend_state == TARGET_RUNNING)
 758         {
 759                 char sig_reply[4];
 760                 int signal_var;
 761
 762                 /* stop forwarding log packets! */
 763                 log_remove_callback(gdb_log_callback, connection);
 764
 765                 if (gdb_connection->ctrl_c)
 766                 {
 767                         signal_var = 0x2;
 768                         gdb_connection->ctrl_c = 0;
 769                 }
 770                 else
 771                 {
 772                         signal_var = gdb_last_signal(target);
 773                 }
 774
 775                 snprintf(sig_reply, 4, "T%2.2x", signal_var);
 776                 gdb_put_packet(connection, sig_reply, 3);
 777                 gdb_connection->frontend_state = TARGET_HALTED;
 778                 rtos_update_threads( target );
 779         }
 780 }
 781
 782 static int gdb_target_callback_event_handler(struct target *target,
 783                 enum target_event event, void *priv)
 784 {
 785         int retval;
 786         struct connection *connection = priv;
 787
 788         target_handle_event(target, event);
 789         switch (event)
 790         {
 791                 case TARGET_EVENT_GDB_HALT:
 792                         gdb_frontend_halted(target, connection);
 793                         break;
 794                 case TARGET_EVENT_HALTED:
 795                         target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
 796                         break;
 797                 case TARGET_EVENT_GDB_FLASH_ERASE_START:
 798                         target_handle_event(target, TARGET_EVENT_OLD_gdb_program_config);
 799                         if ((retval = jtag_execute_queue()) != ERROR_OK)
 800                         {
 801                                 return retval;
 802                         }
 803                         break;
 804                 default:
 805                         break;
 806         }
 807
 808         return ERROR_OK;
 809 }
 810
 811 static int gdb_new_connection(struct connection *connection)
 812 {
 813         struct gdb_connection *gdb_connection = malloc(sizeof(struct gdb_connection));
 814         struct gdb_service *gdb_service = connection->service->priv;
 815         int retval;
 816         int initial_ack;
 817
 818         connection->priv = gdb_connection;
 819
 820         /* initialize gdb connection information */
 821         gdb_connection->buf_p = gdb_connection->buffer;
 822         gdb_connection->buf_cnt = 0;
 823         gdb_connection->ctrl_c = 0;
 824         gdb_connection->frontend_state = TARGET_HALTED;
 825         gdb_connection->vflash_image = NULL;
 826         gdb_connection->closed = 0;
 827         gdb_connection->busy = 0;
 828         gdb_connection->noack_mode = 0;
 829         gdb_connection->sync = true;
 830         gdb_connection->mem_write_error = false;
 831
 832         /* send ACK to GDB for debug request */
 833         gdb_write(connection, "+", 1);
 834
 835         /* output goes through gdb connection */
 836         command_set_output_handler(connection->cmd_ctx, gdb_output, connection);
 837
 838         /* we must remove all breakpoints registered to the target as a previous
 839          * GDB session could leave dangling breakpoints if e.g. communication
 840          * timed out.
 841          */
 842         breakpoint_clear_target(gdb_service->target);
 843         watchpoint_clear_target(gdb_service->target);
 844
 845         /* remove the initial ACK from the incoming buffer */
 846         if ((retval = gdb_get_char(connection, &initial_ack)) != ERROR_OK)
 847                 return retval;
 848
 849         /* FIX!!!??? would we actually ever receive a + here???
 850          * Not observed.
 851          */
 852         if (initial_ack != '+')
 853                 gdb_putback_char(connection, initial_ack);
 854         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_ATTACH);
 855
 856         if (gdb_use_memory_map)
 857         {
 858                 /* Connect must fail if the memory map can't be set up correctly.
 859                  *
 860                  * This will cause an auto_probe to be invoked, which is either
 861                  * a no-op or it will fail when the target isn't ready(e.g. not halted).
 862                  */
 863                 int i;
 864                 for (i = 0; i < flash_get_bank_count(); i++)
 865                 {
 866                         struct flash_bank *p;
 867                         retval = get_flash_bank_by_num(i, &p);
 868                         if (retval != ERROR_OK)
 869                         {
 870                                 LOG_ERROR("Connect failed. Consider setting up a gdb-attach event for the target to prepare target for GDB connect, or use 'gdb_memory_map disable'.");
 871                                 return retval;
 872                         }
 873                 }
 874         }
 875
 876         gdb_actual_connections++;
 877         LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s",
 878                   gdb_actual_connections,
 879                   target_name(gdb_service->target),
 880                   target_state_name(gdb_service->target));
 881
 882         /* DANGER! If we fail subsequently, we must remove this handler,
 883          * otherwise we occasionally see crashes as the timer can invoke the
 884          * callback fn.
 885          *
 886          * register callback to be informed about target events */
 887         target_register_event_callback(gdb_target_callback_event_handler, connection);
 888
 889         return ERROR_OK;
 890 }
 891
 892 static int gdb_connection_closed(struct connection *connection)
 893 {
 894         struct gdb_service *gdb_service = connection->service->priv;
 895         struct gdb_connection *gdb_connection = connection->priv;
 896
 897         /* we're done forwarding messages. Tear down callback before
 898          * cleaning up connection.
 899          */
 900         log_remove_callback(gdb_log_callback, connection);
 901
 902         gdb_actual_connections--;
 903         LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
 904                   target_name(gdb_service->target),
 905                   target_state_name(gdb_service->target),
 906                   gdb_actual_connections);
 907
 908         /* see if an image built with vFlash commands is left */
 909         if (gdb_connection->vflash_image)
 910         {
 911                 image_close(gdb_connection->vflash_image);
 912                 free(gdb_connection->vflash_image);
 913                 gdb_connection->vflash_image = NULL;
 914         }
 915
 916         /* if this connection registered a debug-message receiver delete it */
 917         delete_debug_msg_receiver(connection->cmd_ctx, gdb_service->target);
 918
 919         if (connection->priv)
 920         {
 921                 free(connection->priv);
 922                 connection->priv = NULL;
 923         }
 924         else
 925         {
 926                 LOG_ERROR("BUG: connection->priv == NULL");
 927         }
 928
 929
 930         target_unregister_event_callback(gdb_target_callback_event_handler, connection);
 931
 932         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_END);
 933
 934         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH);
 935
 936         return ERROR_OK;
 937 }
 938
 939 static void gdb_send_error(struct connection *connection, uint8_t the_error)
 940 {
 941         char err[4];
 942         snprintf(err, 4, "E%2.2X", the_error);
 943         gdb_put_packet(connection, err, 3);
 944 }
 945
 946 static int gdb_last_signal_packet(struct connection *connection,
 947                 struct target *target, char* packet, int packet_size)
 948 {
 949         char sig_reply[4];
 950         int signal_var;
 951
 952         signal_var = gdb_last_signal(target);
 953
 954         snprintf(sig_reply, 4, "S%2.2x", signal_var);
 955         gdb_put_packet(connection, sig_reply, 3);
 956
 957         return ERROR_OK;
 958 }
 959
 960 static int gdb_reg_pos(struct target *target, int pos, int len)
 961 {
 962         if (target->endianness == TARGET_LITTLE_ENDIAN)
 963                 return pos;
 964         else
 965                 return len - 1 - pos;
 966 }
 967
 968 /* Convert register to string of bytes. NB! The # of bits in the
 969  * register might be non-divisible by 8(a byte), in which
 970  * case an entire byte is shown.
 971  *
 972  * NB! the format on the wire is the target endianness
 973  *
 974  * The format of reg->value is little endian
 975  *
 976  */
 977 static void gdb_str_to_target(struct target *target,
 978                 char *tstr, struct reg *reg)
 979 {
 980         int i;
 981
 982         uint8_t *buf;
 983         int buf_len;
 984         buf = reg->value;
 985         buf_len = DIV_ROUND_UP(reg->size, 8);
 986
 987         for (i = 0; i < buf_len; i++)
 988         {
 989                 int j = gdb_reg_pos(target, i, buf_len);
 990                 tstr[i*2]   = DIGITS[(buf[j]>>4) & 0xf];
 991                 tstr[i*2 + 1] = DIGITS[buf[j]&0xf];
 992         }
 993 }
 994
 995 static int hextoint(int c)
 996 {
 997         if (c>='0'&&c<='9')
 998         {
 999                 return c-'0';
1000         }
1001         c = toupper(c);
1002         if (c>='A'&&c<='F')
1003         {
1004                 return c-'A'+10;
1005         }
1006         LOG_ERROR("BUG: invalid register value %08x", c);
1007         return 0;
1008 }
1009
1010 /* copy over in register buffer */
1011 static void gdb_target_to_reg(struct target *target,
1012                 char *tstr, int str_len, uint8_t *bin)
1013 {
1014         if (str_len % 2)
1015         {
1016                 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
1017                 exit(-1);
1018         }
1019
1020         int i;
1021         for (i = 0; i < str_len; i += 2)
1022         {
1023                 uint8_t t = hextoint(tstr[i]) << 4;
1024                 t |= hextoint(tstr[i + 1]);
1025
1026                 int j = gdb_reg_pos(target, i/2, str_len/2);
1027                 bin[j] = t;
1028         }
1029 }
1030
1031 static int gdb_get_registers_packet(struct connection *connection,
1032                 struct target *target, char* packet, int packet_size)
1033 {
1034         struct reg **reg_list;
1035         int reg_list_size;
1036         int retval;
1037         int reg_packet_size = 0;
1038         char *reg_packet;
1039         char *reg_packet_p;
1040         int i;
1041
1042 #ifdef _DEBUG_GDB_IO_
1043         LOG_DEBUG("-");
1044 #endif
1045
1046         if ( ( target->rtos != NULL ) &&
1047                  ( ERROR_FAIL != rtos_get_gdb_reg_list( connection, target, &reg_list, &reg_list_size) ) )
1048         {
1049                 return ERROR_OK;
1050         }
1051
1052         if ((retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size)) != ERROR_OK)
1053         {
1054                 return gdb_error(connection, retval);
1055         }
1056
1057         for (i = 0; i < reg_list_size; i++)
1058         {
1059                 reg_packet_size += reg_list[i]->size;
1060         }
1061
1062         reg_packet = malloc(DIV_ROUND_UP(reg_packet_size, 8) * 2);
1063         reg_packet_p = reg_packet;
1064
1065         for (i = 0; i < reg_list_size; i++)
1066         {
1067                 if (!reg_list[i]->valid)
1068                         reg_list[i]->type->get(reg_list[i]);
1069                 gdb_str_to_target(target, reg_packet_p, reg_list[i]);
1070                 reg_packet_p += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
1071         }
1072
1073 #ifdef _DEBUG_GDB_IO_
1074         {
1075                 char *reg_packet_p;
1076                 reg_packet_p = strndup(reg_packet, DIV_ROUND_UP(reg_packet_size, 8) * 2);
1077                 LOG_DEBUG("reg_packet: %s", reg_packet_p);
1078                 free(reg_packet_p);
1079         }
1080 #endif
1081
1082         gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_packet_size, 8) * 2);
1083         free(reg_packet);
1084
1085         free(reg_list);
1086
1087         return ERROR_OK;
1088 }
1089
1090 static int gdb_set_registers_packet(struct connection *connection,
1091                 struct target *target, char *packet, int packet_size)
1092 {
1093         int i;
1094         struct reg **reg_list;
1095         int reg_list_size;
1096         int retval;
1097         char *packet_p;
1098
1099 #ifdef _DEBUG_GDB_IO_
1100         LOG_DEBUG("-");
1101 #endif
1102
1103         /* skip command character */
1104         packet++;
1105         packet_size--;
1106
1107         if (packet_size % 2)
1108         {
1109                 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
1110                 return ERROR_SERVER_REMOTE_CLOSED;
1111         }
1112
1113         if ((retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size)) != ERROR_OK)
1114         {
1115                 return gdb_error(connection, retval);
1116         }
1117
1118         packet_p = packet;
1119         for (i = 0; i < reg_list_size; i++)
1120         {
1121                 uint8_t *bin_buf;
1122                 int chars = (DIV_ROUND_UP(reg_list[i]->size, 8) * 2);
1123
1124                 if (packet_p + chars > packet + packet_size)
1125                 {
1126                         LOG_ERROR("BUG: register packet is too small for registers");
1127                 }
1128
1129                 bin_buf = malloc(DIV_ROUND_UP(reg_list[i]->size, 8));
1130                 gdb_target_to_reg(target, packet_p, chars, bin_buf);
1131
1132                 reg_list[i]->type->set(reg_list[i], bin_buf);
1133
1134                 /* advance packet pointer */
1135                 packet_p += chars;
1136
1137
1138                 free(bin_buf);
1139         }
1140
1141         /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1142         free(reg_list);
1143
1144         gdb_put_packet(connection, "OK", 2);
1145
1146         return ERROR_OK;
1147 }
1148
1149 static int gdb_get_register_packet(struct connection *connection,
1150                 struct target *target, char *packet, int packet_size)
1151 {
1152         char *reg_packet;
1153         int reg_num = strtoul(packet + 1, NULL, 16);
1154         struct reg **reg_list;
1155         int reg_list_size;
1156         int retval;
1157
1158 #ifdef _DEBUG_GDB_IO_
1159         LOG_DEBUG("-");
1160 #endif
1161
1162         if ((retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size)) != ERROR_OK)
1163         {
1164                 return gdb_error(connection, retval);
1165         }
1166
1167         if (reg_list_size <= reg_num)
1168         {
1169                 LOG_ERROR("gdb requested a non-existing register");
1170                 exit(-1);
1171         }
1172
1173         if (!reg_list[reg_num]->valid)
1174                 reg_list[reg_num]->type->get(reg_list[reg_num]);
1175
1176         reg_packet = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1177
1178         gdb_str_to_target(target, reg_packet, reg_list[reg_num]);
1179
1180         gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1181
1182         free(reg_list);
1183         free(reg_packet);
1184
1185         return ERROR_OK;
1186 }
1187
1188 static int gdb_set_register_packet(struct connection *connection,
1189                 struct target *target, char *packet, int packet_size)
1190 {
1191         char *separator;
1192         uint8_t *bin_buf;
1193         int reg_num = strtoul(packet + 1, &separator, 16);
1194         struct reg **reg_list;
1195         int reg_list_size;
1196         int retval;
1197
1198         LOG_DEBUG("-");
1199
1200         if ((retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size)) != ERROR_OK)
1201         {
1202                 return gdb_error(connection, retval);
1203         }
1204
1205         if (reg_list_size < reg_num)
1206         {
1207                 LOG_ERROR("gdb requested a non-existing register");
1208                 return ERROR_SERVER_REMOTE_CLOSED;
1209         }
1210
1211         if (*separator != '=')
1212         {
1213                 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1214                 return ERROR_SERVER_REMOTE_CLOSED;
1215         }
1216
1217         /* convert from GDB-string (target-endian) to hex-string (big-endian) */
1218         bin_buf = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8));
1219         int chars = (DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1220
1221         /* fix!!! add some sanity checks on packet size here */
1222
1223         gdb_target_to_reg(target, separator + 1, chars, bin_buf);
1224
1225         reg_list[reg_num]->type->set(reg_list[reg_num], bin_buf);
1226
1227         gdb_put_packet(connection, "OK", 2);
1228
1229         free(bin_buf);
1230         free(reg_list);
1231
1232         return ERROR_OK;
1233 }
1234
1235 /* No attempt is made to translate the "retval" to
1236  * GDB speak. This has to be done at the calling
1237  * site as no mapping really exists.
1238  */
1239 static int gdb_error(struct connection *connection, int retval)
1240 {
1241         LOG_DEBUG("Reporting %i to GDB as generic error", retval);
1242         gdb_send_error(connection, EFAULT);
1243         return ERROR_OK;
1244 }
1245
1246 /* We don't have to worry about the default 2 second timeout for GDB packets,
1247  * because GDB breaks up large memory reads into smaller reads.
1248  *
1249  * 8191 bytes by the looks of it. Why 8191 bytes instead of 8192?????
1250  */
1251 static int gdb_read_memory_packet(struct connection *connection,
1252                 struct target *target, char *packet, int packet_size)
1253 {
1254         char *separator;
1255         uint32_t addr = 0;
1256         uint32_t len = 0;
1257
1258         uint8_t *buffer;
1259         char *hex_buffer;
1260
1261         int retval = ERROR_OK;
1262
1263         /* skip command character */
1264         packet++;
1265
1266         addr = strtoul(packet, &separator, 16);
1267
1268         if (*separator != ',')
1269         {
1270                 LOG_ERROR("incomplete read memory packet received, dropping connection");
1271                 return ERROR_SERVER_REMOTE_CLOSED;
1272         }
1273
1274         len = strtoul(separator + 1, NULL, 16);
1275
1276         buffer = malloc(len);
1277
1278         LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1279
1280         retval = target_read_buffer(target, addr, len, buffer);
1281
1282         if ((retval != ERROR_OK)&&!gdb_report_data_abort)
1283         {
1284                 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1285                  * At some point this might be fixed in GDB, in which case this code can be removed.
1286                  *
1287                  * OpenOCD developers are acutely aware of this problem, but there is nothing
1288                  * gained by involving the user in this problem that hopefully will get resolved
1289                  * eventually
1290                  *
1291                  * http://sourceware.org/cgi-bin/gnatsweb.pl?cmd = view%20audit-trail&database = gdb&pr = 2395
1292                  *
1293                  * For now, the default is to fix up things to make current GDB versions work.
1294                  * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1295                  */
1296                 memset(buffer, 0, len);
1297                 retval = ERROR_OK;
1298         }
1299
1300         if (retval == ERROR_OK)
1301         {
1302                 hex_buffer = malloc(len * 2 + 1);
1303
1304                 uint32_t i;
1305                 for (i = 0; i < len; i++)
1306                 {
1307                         uint8_t t = buffer[i];
1308                         hex_buffer[2 * i] = DIGITS[(t >> 4) & 0xf];
1309                         hex_buffer[2 * i + 1] = DIGITS[t & 0xf];
1310                 }
1311
1312                 gdb_put_packet(connection, hex_buffer, len * 2);
1313
1314                 free(hex_buffer);
1315         }
1316         else
1317         {
1318                 retval = gdb_error(connection, retval);
1319         }
1320
1321         free(buffer);
1322
1323         return retval;
1324 }
1325
1326 static int gdb_write_memory_packet(struct connection *connection,
1327                 struct target *target, char *packet, int packet_size)
1328 {
1329         char *separator;
1330         uint32_t addr = 0;
1331         uint32_t len = 0;
1332
1333         uint8_t *buffer;
1334
1335         uint32_t i;
1336         int retval;
1337
1338         /* skip command character */
1339         packet++;
1340
1341         addr = strtoul(packet, &separator, 16);
1342
1343         if (*separator != ',')
1344         {
1345                 LOG_ERROR("incomplete write memory packet received, dropping connection");
1346                 return ERROR_SERVER_REMOTE_CLOSED;
1347         }
1348
1349         len = strtoul(separator + 1, &separator, 16);
1350
1351         if (*(separator++) != ':')
1352         {
1353                 LOG_ERROR("incomplete write memory packet received, dropping connection");
1354                 return ERROR_SERVER_REMOTE_CLOSED;
1355         }
1356
1357         buffer = malloc(len);
1358
1359         LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1360
1361         for (i = 0; i < len; i++)
1362         {
1363                 uint32_t tmp;
1364                 sscanf(separator + 2*i, "%2" SCNx32 , &tmp);
1365                 buffer[i] = tmp;
1366         }
1367
1368         retval = target_write_buffer(target, addr, len, buffer);
1369
1370         if (retval == ERROR_OK)
1371         {
1372                 gdb_put_packet(connection, "OK", 2);
1373         }
1374         else
1375         {
1376                 retval = gdb_error(connection, retval);
1377         }
1378
1379         free(buffer);
1380
1381         return retval;
1382 }
1383
1384 static int gdb_write_memory_binary_packet(struct connection *connection,
1385                 struct target *target, char *packet, int packet_size)
1386 {
1387         char *separator;
1388         uint32_t addr = 0;
1389         uint32_t len = 0;
1390
1391         int retval = ERROR_OK;
1392
1393         /* skip command character */
1394         packet++;
1395
1396         addr = strtoul(packet, &separator, 16);
1397
1398         if (*separator != ',')
1399         {
1400                 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1401                 return ERROR_SERVER_REMOTE_CLOSED;
1402         }
1403
1404         len = strtoul(separator + 1, &separator, 16);
1405
1406         if (*(separator++) != ':')
1407         {
1408                 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1409                 return ERROR_SERVER_REMOTE_CLOSED;
1410         }
1411
1412         struct gdb_connection *gdb_connection = connection->priv;
1413
1414         if (gdb_connection->mem_write_error)
1415         {
1416                 retval = ERROR_FAIL;
1417                 /* now that we have reported the memory write error, we can clear the condition */
1418                 gdb_connection->mem_write_error = false;
1419         }
1420
1421         /* By replying the packet *immediately* GDB will send us a new packet
1422          * while we write the last one to the target.
1423          */
1424         if (retval == ERROR_OK)
1425         {
1426                 gdb_put_packet(connection, "OK", 2);
1427         }
1428         else
1429         {
1430                 if ((retval = gdb_error(connection, retval)) != ERROR_OK)
1431                         return retval;
1432         }
1433
1434         if (len)
1435         {
1436                 LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1437
1438                 retval = target_write_buffer(target, addr, len, (uint8_t*)separator);
1439                 if (retval != ERROR_OK)
1440                 {
1441                         gdb_connection->mem_write_error = true;
1442                 }
1443         }
1444
1445         return ERROR_OK;
1446 }
1447
1448 static int gdb_step_continue_packet(struct connection *connection,
1449                 struct target *target, char *packet, int packet_size)
1450 {
1451         int current = 0;
1452         uint32_t address = 0x0;
1453         int retval = ERROR_OK;
1454
1455         LOG_DEBUG("-");
1456
1457         if (packet_size > 1)
1458         {
1459                 packet[packet_size] = 0;
1460                 address = strtoul(packet + 1, NULL, 16);
1461         }
1462         else
1463         {
1464                 current = 1;
1465         }
1466
1467         if (packet[0] == 'c')
1468         {
1469                 LOG_DEBUG("continue");
1470                 target_handle_event(target, TARGET_EVENT_OLD_pre_resume);
1471                 retval = target_resume(target, current, address, 0, 0); /* resume at current address, don't handle breakpoints, not debugging */
1472         }
1473         else if (packet[0] == 's')
1474         {
1475                 LOG_DEBUG("step");
1476                 /* step at current or address, don't handle breakpoints */
1477                 retval = target_step(target, current, address, 0);
1478         }
1479         return retval;
1480 }
1481
1482 static int gdb_breakpoint_watchpoint_packet(struct connection *connection,
1483                 struct target *target, char *packet, int packet_size)
1484 {
1485         int type;
1486         enum breakpoint_type bp_type = BKPT_SOFT /* dummy init to avoid warning */;
1487         enum watchpoint_rw wp_type = WPT_READ /* dummy init to avoid warning */;
1488         uint32_t address;
1489         uint32_t size;
1490         char *separator;
1491         int retval;
1492
1493         LOG_DEBUG("-");
1494
1495         type = strtoul(packet + 1, &separator, 16);
1496
1497         if (type == 0)  /* memory breakpoint */
1498                 bp_type = BKPT_SOFT;
1499         else if (type == 1) /* hardware breakpoint */
1500                 bp_type = BKPT_HARD;
1501         else if (type == 2) /* write watchpoint */
1502                 wp_type = WPT_WRITE;
1503         else if (type == 3) /* read watchpoint */
1504                 wp_type = WPT_READ;
1505         else if (type == 4) /* access watchpoint */
1506                 wp_type = WPT_ACCESS;
1507         else
1508         {
1509                 LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type);
1510                 return ERROR_SERVER_REMOTE_CLOSED;
1511         }
1512
1513
1514         if (gdb_breakpoint_override && ((bp_type == BKPT_SOFT)||(bp_type == BKPT_HARD)))
1515         {
1516                 bp_type = gdb_breakpoint_override_type;
1517         }
1518
1519         if (*separator != ',')
1520         {
1521                 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1522                 return ERROR_SERVER_REMOTE_CLOSED;
1523         }
1524
1525         address = strtoul(separator + 1, &separator, 16);
1526
1527         if (*separator != ',')
1528         {
1529                 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1530                 return ERROR_SERVER_REMOTE_CLOSED;
1531         }
1532
1533         size = strtoul(separator + 1, &separator, 16);
1534
1535         switch (type)
1536         {
1537                 case 0:
1538                 case 1:
1539                         if (packet[0] == 'Z')
1540                         {
1541                                 if ((retval = breakpoint_add(target, address, size, bp_type)) != ERROR_OK)
1542                                 {
1543                                         if ((retval = gdb_error(connection, retval)) != ERROR_OK)
1544                                                 return retval;
1545                                 }
1546                                 else
1547                                 {
1548                                         gdb_put_packet(connection, "OK", 2);
1549                                 }
1550                         }
1551                         else
1552                         {
1553                                 breakpoint_remove(target, address);
1554                                 gdb_put_packet(connection, "OK", 2);
1555                         }
1556                         break;
1557                 case 2:
1558                 case 3:
1559                 case 4:
1560                 {
1561                         if (packet[0] == 'Z')
1562                         {
1563                                 if ((retval = watchpoint_add(target, address, size, wp_type, 0, 0xffffffffu)) != ERROR_OK)
1564                                 {
1565                                         if ((retval = gdb_error(connection, retval)) != ERROR_OK)
1566                                                 return retval;
1567                                 }
1568                                 else
1569                                 {
1570                                         gdb_put_packet(connection, "OK", 2);
1571                                 }
1572                         }
1573                         else
1574                         {
1575                                 watchpoint_remove(target, address);
1576                                 gdb_put_packet(connection, "OK", 2);
1577                         }
1578                         break;
1579                 }
1580                 default:
1581                         break;
1582         }
1583
1584         return ERROR_OK;
1585 }
1586
1587 /* print out a string and allocate more space as needed,
1588  * mainly used for XML at this point
1589  */
1590 static void xml_printf(int *retval, char **xml, int *pos, int *size,
1591                 const char *fmt, ...)
1592 {
1593         if (*retval != ERROR_OK)
1594         {
1595                 return;
1596         }
1597         int first = 1;
1598
1599         for (;;)
1600         {
1601                 if ((*xml == NULL) || (!first))
1602                 {
1603                         /* start by 0 to exercise all the code paths.
1604                          * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1605
1606                         *size = *size * 2 + 2;
1607                         char *t = *xml;
1608                         *xml = realloc(*xml, *size);
1609                         if (*xml == NULL)
1610                         {
1611                                 if (t)
1612                                         free(t);
1613                                 *retval = ERROR_SERVER_REMOTE_CLOSED;
1614                                 return;
1615                         }
1616                 }
1617
1618                 va_list ap;
1619                 int ret;
1620                 va_start(ap, fmt);
1621                 ret = vsnprintf(*xml + *pos, *size - *pos, fmt, ap);
1622                 va_end(ap);
1623                 if ((ret > 0) && ((ret + 1) < *size - *pos))
1624                 {
1625                         *pos += ret;
1626                         return;
1627                 }
1628                 /* there was just enough or not enough space, allocate more. */
1629                 first = 0;
1630         }
1631 }
1632
1633 static int decode_xfer_read(char *buf, char **annex, int *ofs, unsigned int *len)
1634 {
1635         char *separator;
1636
1637         /* Extract and NUL-terminate the annex. */
1638         *annex = buf;
1639         while (*buf && *buf != ':')
1640                 buf++;
1641         if (*buf == '\0')
1642                 return -1;
1643         *buf++ = 0;
1644
1645         /* After the read marker and annex, qXfer looks like a
1646          * traditional 'm' packet. */
1647
1648         *ofs = strtoul(buf, &separator, 16);
1649
1650         if (*separator != ',')
1651                 return -1;
1652
1653         *len = strtoul(separator + 1, NULL, 16);
1654
1655         return 0;
1656 }
1657
1658 static int compare_bank (const void * a, const void * b)
1659 {
1660         struct flash_bank *b1, *b2;
1661         b1=*((struct flash_bank **)a);
1662         b2=*((struct flash_bank **)b);
1663
1664         if (b1->base == b2->base)
1665         {
1666                 return 0;
1667         } else if (b1->base > b2->base)
1668         {
1669                 return 1;
1670         } else
1671         {
1672                 return -1;
1673         }
1674 }
1675
1676 static int gdb_memory_map(struct connection *connection,
1677                 struct target *target, char *packet, int packet_size)
1678 {
1679         /* We get away with only specifying flash here. Regions that are not
1680          * specified are treated as if we provided no memory map(if not we
1681          * could detect the holes and mark them as RAM).
1682          * Normally we only execute this code once, but no big deal if we
1683          * have to regenerate it a couple of times.
1684          */
1685
1686         struct flash_bank *p;
1687         char *xml = NULL;
1688         int size = 0;
1689         int pos = 0;
1690         int retval = ERROR_OK;
1691         struct flash_bank **banks;
1692         int offset;
1693         int length;
1694         char *separator;
1695         uint32_t ram_start = 0;
1696         int i;
1697         int target_flash_banks = 0;
1698
1699         /* skip command character */
1700         packet += 23;
1701
1702         offset = strtoul(packet, &separator, 16);
1703         length = strtoul(separator + 1, &separator, 16);
1704
1705         xml_printf(&retval, &xml, &pos, &size, "<memory-map>\n");
1706
1707         /* Sort banks in ascending order.  We need to report non-flash
1708          * memory as ram (or rather read/write) by default for GDB, since
1709          * it has no concept of non-cacheable read/write memory (i/o etc).
1710          *
1711          * FIXME Most non-flash addresses are *NOT* RAM!  Don't lie.
1712          * Current versions of GDB assume unlisted addresses are RAM...
1713          */
1714         banks = malloc(sizeof(struct flash_bank *)*flash_get_bank_count());
1715
1716         for (i = 0; i < flash_get_bank_count(); i++) {
1717                 retval = get_flash_bank_by_num(i, &p);
1718                 if (retval != ERROR_OK)
1719                 {
1720                         free(banks);
1721                         gdb_error(connection, retval);
1722                         return retval;
1723                 }
1724                 if(p->target == target)
1725                         banks[target_flash_banks++] = p;
1726         }
1727
1728         qsort(banks, target_flash_banks, sizeof(struct flash_bank *),
1729                         compare_bank);
1730
1731         for (i = 0; i < flash_get_bank_count(); i++) {
1732                 int j;
1733                 unsigned sector_size = 0;
1734                 uint32_t start, end;
1735
1736                 p = banks[i];
1737                 start = p->base;
1738                 end = p->base + p->size;
1739
1740                 if (ram_start < p->base)
1741                         xml_printf(&retval, &xml, &pos, &size,
1742                                 "<memory type=\"ram\" start=\"0x%x\" "
1743                                         "length=\"0x%x\"/>\n",
1744                                 ram_start, p->base - ram_start);
1745
1746                 /* Report adjacent groups of same-size sectors.  So for
1747                  * example top boot CFI flash will list an initial region
1748                  * with several large sectors (maybe 128KB) and several
1749                  * smaller ones at the end (maybe 32KB).  STR7 will have
1750                  * regions with 8KB, 32KB, and 64KB sectors; etc.
1751                  */
1752                 for (j = 0; j < p->num_sectors; j++) {
1753                         unsigned group_len;
1754
1755                         /* Maybe start a new group of sectors. */
1756                         if (sector_size == 0) {
1757                                 start = p->base + p->sectors[j].offset;
1758                                 xml_printf(&retval, &xml, &pos, &size,
1759                                         "<memory type=\"flash\" "
1760                                                 "start=\"0x%x\" ",
1761                                         start);
1762                                 sector_size = p->sectors[j].size;
1763                         }
1764
1765                         /* Does this finish a group of sectors?
1766                          * If not, continue an already-started group.
1767                          */
1768                         if (j == p->num_sectors -1)
1769                                 group_len = (p->base + p->size) - start;
1770                         else if (p->sectors[j + 1].size != sector_size)
1771                                 group_len = p->base + p->sectors[j + 1].offset
1772                                                 - start;
1773                         else
1774                                 continue;
1775
1776                         xml_printf(&retval, &xml, &pos, &size,
1777                                 "length=\"0x%x\">\n"
1778                                 "<property name=\"blocksize\">"
1779                                         "0x%x</property>\n"
1780                                 "</memory>\n",
1781                                 group_len,
1782                                 sector_size);
1783                         sector_size = 0;
1784                 }
1785
1786                 ram_start = p->base + p->size;
1787         }
1788
1789         if (ram_start != 0)
1790                 xml_printf(&retval, &xml, &pos, &size,
1791                         "<memory type=\"ram\" start=\"0x%x\" "
1792                                 "length=\"0x%x\"/>\n",
1793                         ram_start, 0-ram_start);
1794         /* ELSE a flash chip could be at the very end of the 32 bit address
1795          * space, in which case ram_start will be precisely 0
1796          */
1797
1798         free(banks);
1799         banks = NULL;
1800
1801         xml_printf(&retval, &xml, &pos, &size, "</memory-map>\n");
1802
1803         if (retval != ERROR_OK) {
1804                 gdb_error(connection, retval);
1805                 return retval;
1806         }
1807
1808         if (offset + length > pos)
1809                 length = pos - offset;
1810
1811         char *t = malloc(length + 1);
1812         t[0] = 'l';
1813         memcpy(t + 1, xml + offset, length);
1814         gdb_put_packet(connection, t, length + 1);
1815
1816         free(t);
1817         free(xml);
1818         return ERROR_OK;
1819 }
1820
1821 static int gdb_query_packet(struct connection *connection,
1822         struct target *target, char *packet, int packet_size)
1823 {
1824         struct command_context *cmd_ctx = connection->cmd_ctx;
1825         struct gdb_connection *gdb_connection = connection->priv;
1826
1827         if (strstr(packet, "qRcmd,"))
1828         {
1829                 if (packet_size > 6)
1830                 {
1831                         char *cmd;
1832                         int i;
1833                         cmd = malloc((packet_size - 6)/2 + 1);
1834                         for (i = 0; i < (packet_size - 6)/2; i++)
1835                         {
1836                                 uint32_t tmp;
1837                                 sscanf(packet + 6 + 2*i, "%2" SCNx32 , &tmp);
1838                                 cmd[i] = tmp;
1839                         }
1840                         cmd[(packet_size - 6)/2] = 0x0;
1841
1842                         /* We want to print all debug output to GDB connection */
1843                         log_add_callback(gdb_log_callback, connection);
1844                         target_call_timer_callbacks_now();
1845                         /* some commands need to know the GDB connection, make note of current
1846                          * GDB connection. */
1847                         current_gdb_connection = gdb_connection;
1848                         command_run_line(cmd_ctx, cmd);
1849                         current_gdb_connection = NULL;
1850                         target_call_timer_callbacks_now();
1851                         log_remove_callback(gdb_log_callback, connection);
1852                         free(cmd);
1853                 }
1854                 gdb_put_packet(connection, "OK", 2);
1855                 return ERROR_OK;
1856         }
1857         else if (strstr(packet, "qCRC:"))
1858         {
1859                 if (packet_size > 5)
1860                 {
1861                         int retval;
1862                         char gdb_reply[10];
1863                         char *separator;
1864                         uint32_t checksum;
1865                         uint32_t addr = 0;
1866                         uint32_t len = 0;
1867
1868                         /* skip command character */
1869                         packet += 5;
1870
1871                         addr = strtoul(packet, &separator, 16);
1872
1873                         if (*separator != ',')
1874                         {
1875                                 LOG_ERROR("incomplete read memory packet received, dropping connection");
1876                                 return ERROR_SERVER_REMOTE_CLOSED;
1877                         }
1878
1879                         len = strtoul(separator + 1, NULL, 16);
1880
1881                         retval = target_checksum_memory(target, addr, len, &checksum);
1882
1883                         if (retval == ERROR_OK)
1884                         {
1885                                 snprintf(gdb_reply, 10, "C%8.8" PRIx32 "", checksum);
1886                                 gdb_put_packet(connection, gdb_reply, 9);
1887                         }
1888                         else
1889                         {
1890                                 if ((retval = gdb_error(connection, retval)) != ERROR_OK)
1891                                         return retval;
1892                         }
1893
1894                         return ERROR_OK;
1895                 }
1896         }
1897         else if (strstr(packet, "qSupported"))
1898         {
1899                 /* we currently support packet size and qXfer:memory-map:read (if enabled)
1900                  * disable qXfer:features:read for the moment */
1901                 int retval = ERROR_OK;
1902                 char *buffer = NULL;
1903                 int pos = 0;
1904                 int size = 0;
1905
1906                 xml_printf(&retval, &buffer, &pos, &size,
1907                                 "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read-;QStartNoAckMode+",
1908                                 (GDB_BUFFER_SIZE - 1), ((gdb_use_memory_map == 1) && (flash_get_bank_count() > 0)) ? '+' : '-');
1909
1910                 if (retval != ERROR_OK)
1911                 {
1912                         gdb_send_error(connection, 01);
1913                         return ERROR_OK;
1914                 }
1915
1916                 gdb_put_packet(connection, buffer, strlen(buffer));
1917                 free(buffer);
1918
1919                 return ERROR_OK;
1920         }
1921         else if (strstr(packet, "qXfer:memory-map:read::")
1922                         && (flash_get_bank_count() > 0))
1923                 return gdb_memory_map(connection, target, packet, packet_size);
1924         else if (strstr(packet, "qXfer:features:read:"))
1925         {
1926                 char *xml = NULL;
1927                 int size = 0;
1928                 int pos = 0;
1929                 int retval = ERROR_OK;
1930
1931                 int offset;
1932                 unsigned int length;
1933                 char *annex;
1934
1935                 /* skip command character */
1936                 packet += 20;
1937
1938                 if (decode_xfer_read(packet, &annex, &offset, &length) < 0)
1939                 {
1940                         gdb_send_error(connection, 01);
1941                         return ERROR_OK;
1942                 }
1943
1944                 if (strcmp(annex, "target.xml") != 0)
1945                 {
1946                         gdb_send_error(connection, 01);
1947                         return ERROR_OK;
1948                 }
1949
1950                 xml_printf(&retval, &xml, &pos, &size, \
1951                         "l < target version=\"1.0\">\n < architecture > arm</architecture>\n</target>\n");
1952
1953                 if (retval != ERROR_OK)
1954                 {
1955                         gdb_error(connection, retval);
1956                         return retval;
1957                 }
1958
1959                 gdb_put_packet(connection, xml, strlen(xml));
1960
1961                 free(xml);
1962                 return ERROR_OK;
1963         }
1964         else if (strstr(packet, "QStartNoAckMode"))
1965         {
1966                 gdb_connection->noack_mode = 1;
1967                 gdb_put_packet(connection, "OK", 2);
1968                 return ERROR_OK;
1969         }
1970
1971         gdb_put_packet(connection, "", 0);
1972         return ERROR_OK;
1973 }
1974
1975 static int gdb_v_packet(struct connection *connection,
1976                 struct target *target, char *packet, int packet_size)
1977 {
1978         struct gdb_connection *gdb_connection = connection->priv;
1979         struct gdb_service *gdb_service = connection->service->priv;
1980         int result;
1981
1982         /* if flash programming disabled - send a empty reply */
1983
1984         if (gdb_flash_program == 0)
1985         {
1986                 gdb_put_packet(connection, "", 0);
1987                 return ERROR_OK;
1988         }
1989
1990         if (strstr(packet, "vFlashErase:"))
1991         {
1992                 unsigned long addr;
1993                 unsigned long length;
1994
1995                 char *parse = packet + 12;
1996                 if (*parse == '\0')
1997                 {
1998                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1999                         return ERROR_SERVER_REMOTE_CLOSED;
2000                 }
2001
2002                 addr = strtoul(parse, &parse, 16);
2003
2004                 if (*(parse++) != ',' || *parse == '\0')
2005                 {
2006                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2007                         return ERROR_SERVER_REMOTE_CLOSED;
2008                 }
2009
2010                 length = strtoul(parse, &parse, 16);
2011
2012                 if (*parse != '\0')
2013                 {
2014                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2015                         return ERROR_SERVER_REMOTE_CLOSED;
2016                 }
2017
2018                 /* assume all sectors need erasing - stops any problems
2019                  * when flash_write is called multiple times */
2020                 flash_set_dirty();
2021
2022                 /* perform any target specific operations before the erase */
2023                 target_call_event_callbacks(gdb_service->target,
2024                                 TARGET_EVENT_GDB_FLASH_ERASE_START);
2025
2026                 /* vFlashErase:addr,length messages require region start and
2027                  * end to be "block" aligned ... if padding is ever needed,
2028                  * GDB will have become dangerously confused.
2029                  */
2030                 result = flash_erase_address_range(gdb_service->target,
2031                                 false, addr, length);
2032
2033                 /* perform any target specific operations after the erase */
2034                 target_call_event_callbacks(gdb_service->target,
2035                                 TARGET_EVENT_GDB_FLASH_ERASE_END);
2036
2037                 /* perform erase */
2038                 if (result != ERROR_OK)
2039                 {
2040                         /* GDB doesn't evaluate the actual error number returned,
2041                          * treat a failed erase as an I/O error
2042                          */
2043                         gdb_send_error(connection, EIO);
2044                         LOG_ERROR("flash_erase returned %i", result);
2045                 }
2046                 else
2047                         gdb_put_packet(connection, "OK", 2);
2048
2049                 return ERROR_OK;
2050         }
2051
2052         if (strstr(packet, "vFlashWrite:"))
2053         {
2054                 int retval;
2055                 unsigned long addr;
2056                 unsigned long length;
2057                 char *parse = packet + 12;
2058
2059                 if (*parse == '\0')
2060                 {
2061                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2062                         return ERROR_SERVER_REMOTE_CLOSED;
2063                 }
2064                 addr = strtoul(parse, &parse, 16);
2065                 if (*(parse++) != ':')
2066                 {
2067                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2068                         return ERROR_SERVER_REMOTE_CLOSED;
2069                 }
2070                 length = packet_size - (parse - packet);
2071
2072                 /* create a new image if there isn't already one */
2073                 if (gdb_connection->vflash_image == NULL)
2074                 {
2075                         gdb_connection->vflash_image = malloc(sizeof(struct image));
2076                         image_open(gdb_connection->vflash_image, "", "build");
2077                 }
2078
2079                 /* create new section with content from packet buffer */
2080                 if ((retval = image_add_section(gdb_connection->vflash_image, addr, length, 0x0, (uint8_t*)parse)) != ERROR_OK)
2081                 {
2082                         return retval;
2083                 }
2084
2085                 gdb_put_packet(connection, "OK", 2);
2086
2087                 return ERROR_OK;
2088         }
2089
2090         if (!strcmp(packet, "vFlashDone"))
2091         {
2092                 uint32_t written;
2093
2094                 /* process the flashing buffer. No need to erase as GDB
2095                  * always issues a vFlashErase first. */
2096                 target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_WRITE_START);
2097                 result = flash_write(gdb_service->target, gdb_connection->vflash_image, &written, 0);
2098                 target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_WRITE_END);
2099                 if (result != ERROR_OK)
2100                 {
2101                         if (result == ERROR_FLASH_DST_OUT_OF_BANK)
2102                                 gdb_put_packet(connection, "E.memtype", 9);
2103                         else
2104                                 gdb_send_error(connection, EIO);
2105                         }
2106                 else
2107                 {
2108                         LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written);
2109                         gdb_put_packet(connection, "OK", 2);
2110                 }
2111
2112                 image_close(gdb_connection->vflash_image);
2113                 free(gdb_connection->vflash_image);
2114                 gdb_connection->vflash_image = NULL;
2115
2116                 return ERROR_OK;
2117         }
2118
2119         gdb_put_packet(connection, "", 0);
2120         return ERROR_OK;
2121 }
2122
2123 static int gdb_detach(struct connection *connection, struct target *target)
2124 {
2125         struct gdb_service *gdb_service = connection->service->priv;
2126
2127         target_call_event_callbacks(gdb_service->target,
2128                         TARGET_EVENT_GDB_DETACH);
2129
2130         return gdb_put_packet(connection, "OK", 2);
2131 }
2132
2133 static void gdb_log_callback(void *priv, const char *file, unsigned line,
2134                 const char *function, const char *string)
2135 {
2136         struct connection *connection = priv;
2137         struct gdb_connection *gdb_con = connection->priv;
2138
2139         if (gdb_con->busy)
2140         {
2141                 /* do not reply this using the O packet */
2142                 return;
2143         }
2144
2145         gdb_output_con(connection, string);
2146 }
2147
2148 static void gdb_sig_halted(struct connection *connection)
2149 {
2150         char sig_reply[4];
2151         snprintf(sig_reply, 4, "T%2.2x", 2);
2152         gdb_put_packet(connection, sig_reply, 3);
2153
2154 }
2155
2156 static int gdb_input_inner(struct connection *connection)
2157 {
2158         /* Do not allocate this on the stack */
2159         static char gdb_packet_buffer[GDB_BUFFER_SIZE];
2160
2161         struct gdb_service *gdb_service = connection->service->priv;
2162         struct target *target = gdb_service->target;
2163         char *packet = gdb_packet_buffer;
2164         int packet_size;
2165         int retval;
2166         struct gdb_connection *gdb_con = connection->priv;
2167         static int extended_protocol = 0;
2168
2169         /* drain input buffer. If one of the packets fail, then an error
2170          * packet is replied, if applicable.
2171          *
2172          * This loop will terminate and the error code is returned.
2173          *
2174          * The calling fn will check if this error is something that
2175          * can be recovered from, or if the connection must be closed.
2176          *
2177          * If the error is recoverable, this fn is called again to
2178          * drain the rest of the buffer.
2179          */
2180         do
2181         {
2182                 packet_size = GDB_BUFFER_SIZE-1;
2183                 retval = gdb_get_packet(connection, packet, &packet_size);
2184                 if (retval != ERROR_OK)
2185                         return retval;
2186
2187                 /* terminate with zero */
2188                 packet[packet_size] = 0;
2189
2190                 if (LOG_LEVEL_IS(LOG_LVL_DEBUG)) {
2191                         if (packet[0] == 'X') {
2192                                 // binary packets spew junk into the debug log stream
2193                                 char buf[ 50 ];
2194                                 int x;
2195                                 for (x = 0 ; (x < 49) && (packet[x] != ':') ; x++) {
2196                                         buf[x] = packet[x];
2197                                 }
2198                                 buf[x] = 0;
2199                                 LOG_DEBUG("received packet: '%s:<binary-data>'", buf);
2200                         } else {
2201                                 LOG_DEBUG("received packet: '%s'", packet);
2202                         }
2203                 }
2204
2205                 if (packet_size > 0)
2206                 {
2207                         retval = ERROR_OK;
2208                         switch (packet[0])
2209                         {
2210                             case 'T': // Is thread alive?
2211                                 gdb_thread_packet(connection, target, packet, packet_size);
2212                                 break;
2213                             case 'H': // Set current thread ( 'c' for step and continue, 'g' for all other operations )
2214                                 gdb_thread_packet(connection, target, packet, packet_size);
2215                                 break;
2216                                 case 'q':
2217                                 case 'Q':
2218                                         retval = gdb_thread_packet(connection,
2219                                                                                                 target, packet,
2220                                                                                                 packet_size);
2221                                         if ( retval == GDB_THREAD_PACKET_NOT_CONSUMED )
2222                                         {
2223                                                 retval = gdb_query_packet(connection,
2224                                                                 target, packet,
2225                                                                 packet_size);
2226                                         }
2227                                         break;
2228                                 case 'g':
2229                                         retval = gdb_get_registers_packet(
2230                                                         connection, target,
2231                                                         packet, packet_size);
2232                                         break;
2233                                 case 'G':
2234                                         retval = gdb_set_registers_packet(
2235                                                         connection, target,
2236                                                         packet, packet_size);
2237                                         break;
2238                                 case 'p':
2239                                         retval = gdb_get_register_packet(
2240                                                         connection, target,
2241                                                         packet, packet_size);
2242                                         break;
2243                                 case 'P':
2244                                         retval = gdb_set_register_packet(
2245                                                         connection, target,
2246                                                         packet, packet_size);
2247                                         break;
2248                                 case 'm':
2249                                         retval = gdb_read_memory_packet(
2250                                                         connection, target,
2251                                                         packet, packet_size);
2252                                         break;
2253                                 case 'M':
2254                                         retval = gdb_write_memory_packet(
2255                                                         connection, target,
2256                                                         packet, packet_size);
2257                                         break;
2258                                 case 'z':
2259                                 case 'Z':
2260                                         retval = gdb_breakpoint_watchpoint_packet(connection, target, packet, packet_size);
2261                                         break;
2262                                 case '?':
2263                                         gdb_last_signal_packet(
2264                                                         connection, target,
2265                                                         packet, packet_size);
2266                                         break;
2267                                 case 'c':
2268                                 case 's':
2269                                         {
2270                                                 log_add_callback(gdb_log_callback, connection);
2271
2272                                                 if (gdb_con->mem_write_error)
2273                                                 {
2274                                                         LOG_ERROR("Memory write failure!");
2275
2276                                                         /* now that we have reported the memory write error, we can clear the condition */
2277                                                         gdb_con->mem_write_error = false;
2278                                                 }
2279
2280                                                 bool nostep = false;
2281                                                 bool already_running = false;
2282                                                 if (target->state == TARGET_RUNNING)
2283                                                 {
2284                                                         LOG_WARNING("WARNING! The target is already running. "
2285                                                                         "All changes GDB did to registers will be discarded! "
2286                                                                         "Waiting for target to halt.");
2287                                                         already_running = true;
2288                                                 } else if (target->state != TARGET_HALTED)
2289                                                 {
2290                                                         LOG_WARNING("The target is not in the halted nor running stated, stepi/continue ignored.");
2291                                                         nostep = true;
2292                                                 } else if ((packet[0] == 's') && gdb_con->sync)
2293                                                 {
2294                                                         /* Hmm..... when you issue a continue in GDB, then a "stepi" is
2295                                                          * sent by GDB first to OpenOCD, thus defeating the check to
2296                                                          * make only the single stepping have the sync feature...
2297                                                          */
2298                                                         nostep = true;
2299                                                         LOG_WARNING("stepi ignored. GDB will now fetch the register state from the target.");
2300                                                 }
2301                                                 gdb_con->sync = false;
2302
2303                                                 if (!already_running && nostep)
2304                                                 {
2305                                                         /* Either the target isn't in the halted state, then we can't
2306                                                          * step/continue. This might be early setup, etc.
2307                                                          *
2308                                                          * Or we want to allow GDB to pick up a fresh set of
2309                                                          * register values without modifying the target state.
2310                                                          *
2311                                                          */
2312                                                         gdb_sig_halted(connection);
2313
2314                                                         /* stop forwarding log packets! */
2315                                                         log_remove_callback(gdb_log_callback, connection);
2316                                                 } else
2317                                                 {
2318                                                         /* We're running/stepping, in which case we can
2319                                                          * forward log output until the target is halted
2320                                                          */
2321                                                         gdb_con->frontend_state = TARGET_RUNNING;
2322                                                         target_call_event_callbacks(target, TARGET_EVENT_GDB_START);
2323
2324                                                         if (!already_running)
2325                                                         {
2326                                                                 /* Here we don't want packet processing to stop even if this fails,
2327                                                                  * so we use a local variable instead of retval. */
2328                                                                 retval = gdb_step_continue_packet(connection, target, packet, packet_size);
2329                                                                 if (retval != ERROR_OK)
2330                                                                 {
2331                                                                         /* we'll never receive a halted condition... issue a false one.. */
2332                                                                         gdb_frontend_halted(target, connection);
2333                                                                 }
2334                                                         }
2335                                                 }
2336                                         }
2337                                         break;
2338                                 case 'v':
2339                                         retval = gdb_v_packet(
2340                                                         connection, target,
2341                                                         packet, packet_size);
2342                                         break;
2343                                 case 'D':
2344                                         retval = gdb_detach(connection, target);
2345                                         extended_protocol = 0;
2346                                         break;
2347                                 case 'X':
2348                                         retval = gdb_write_memory_binary_packet(
2349                                                         connection, target,
2350                                                         packet, packet_size);
2351                                         if (retval != ERROR_OK)
2352                                                 return retval;
2353                                         break;
2354                                 case 'k':
2355                                         if (extended_protocol != 0)
2356                                                 break;
2357                                         gdb_put_packet(connection, "OK", 2);
2358                                         return ERROR_SERVER_REMOTE_CLOSED;
2359                                 case '!':
2360                                         /* handle extended remote protocol */
2361                                         extended_protocol = 1;
2362                                         gdb_put_packet(connection, "OK", 2);
2363                                         break;
2364                                 case 'R':
2365                                         /* handle extended restart packet */
2366                                         breakpoint_clear_target(gdb_service->target);
2367                                         watchpoint_clear_target(gdb_service->target);
2368                                         command_run_linef(connection->cmd_ctx,
2369                                                         "ocd_gdb_restart %s",
2370                                                         target_name(target));
2371                                         gdb_put_packet(connection, "OK", 2);
2372                                         break;
2373
2374                                 case 'j':
2375                                     /*  packet supported only by smp target i.e cortex_a.c*/
2376                                         /* handle smp packet replying coreid played to gbd */
2377                                         gdb_read_smp_packet(
2378                                                         connection, target,
2379                                                         packet, packet_size);
2380                                         break;
2381
2382                                 case 'J':
2383                                         /*  packet supported only by smp target i.e cortex_a.c */
2384                                         /*  handle smp packet setting coreid to be played at next
2385                                          *  resume to gdb */
2386                                         gdb_write_smp_packet(
2387                                                         connection, target,
2388                                                         packet, packet_size);
2389                                         break;
2390
2391                                 default:
2392                                         /* ignore unknown packets */
2393                                         LOG_DEBUG("ignoring 0x%2.2x packet", packet[0]);
2394                                         gdb_put_packet(connection, NULL, 0);
2395                                         break;
2396                         }
2397
2398                         /* if a packet handler returned an error, exit input loop */
2399                         if (retval != ERROR_OK)
2400                                 return retval;
2401                 }
2402
2403                 if (gdb_con->ctrl_c)
2404                 {
2405                         if (target->state == TARGET_RUNNING)
2406                         {
2407                                 retval = target_halt(target);
2408                                 if (retval != ERROR_OK)
2409                                 {
2410                                         target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2411                                 }
2412                                 gdb_con->ctrl_c = 0;
2413                         } else
2414                         {
2415                                 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
2416                                 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2417                         }
2418                 }
2419
2420         } while (gdb_con->buf_cnt > 0);
2421
2422         return ERROR_OK;
2423 }
2424
2425 static int gdb_input(struct connection *connection)
2426 {
2427         int retval = gdb_input_inner(connection);
2428         struct gdb_connection *gdb_con = connection->priv;
2429         if (retval == ERROR_SERVER_REMOTE_CLOSED)
2430                 return retval;
2431
2432         /* logging does not propagate the error, yet can set the gdb_con->closed flag */
2433         if (gdb_con->closed)
2434                 return ERROR_SERVER_REMOTE_CLOSED;
2435
2436         /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
2437         return ERROR_OK;
2438 }
2439
2440 static int gdb_target_start(struct target *target, const char *port)
2441 {
2442
2443         struct gdb_service *gdb_service;
2444         int ret;
2445         gdb_service = malloc(sizeof(struct gdb_service));
2446
2447         if (NULL == gdb_service)
2448                 return -ENOMEM;
2449
2450         gdb_service->target = target;
2451         gdb_service->core[0] = -1;
2452         gdb_service->core[1] = -1;
2453         target->gdb_service = gdb_service;
2454
2455         ret = add_service("gdb",
2456                         port, 1, &gdb_new_connection, &gdb_input,
2457                         &gdb_connection_closed, gdb_service);
2458         /* initialialize all targets gdb service with the same pointer */
2459         {
2460                 struct target_list *head;
2461                 struct target *curr;
2462                 head = target->head;
2463                 while(head != (struct target_list*)NULL)
2464                 {
2465                         curr = head->target;
2466                         if (curr != target) curr->gdb_service = gdb_service;
2467                         head = head->next;
2468                 }
2469         }
2470         return ret;
2471 }
2472
2473 static int gdb_target_add_one(struct target *target)
2474 {
2475         /*  one gdb instance per smp list */
2476         if ((target->smp) && (target->gdb_service)) return ERROR_OK;
2477         int retval = gdb_target_start(target, gdb_port_next);
2478         if (retval == ERROR_OK)
2479         {
2480                 long portnumber;
2481                 /* If we can parse the port number
2482                  * then we increment the port number for the next target.
2483                  */
2484                 char *end;
2485                 portnumber = strtol(gdb_port_next, &end, 0);
2486                 if (!*end)
2487                 {
2488                         if (parse_long(gdb_port_next, &portnumber) == ERROR_OK)
2489                         {
2490                                 free((void *)gdb_port_next);
2491                                 gdb_port_next = alloc_printf("%d", portnumber+1);
2492                         }
2493                 }
2494         }
2495         return retval;
2496 }
2497
2498 int gdb_target_add_all(struct target *target)
2499 {
2500         if (NULL == target)
2501         {
2502                 LOG_WARNING("gdb services need one or more targets defined");
2503                 return ERROR_OK;
2504         }
2505
2506         while (NULL != target)
2507         {
2508                 int retval = gdb_target_add_one(target);
2509                 if (ERROR_OK != retval)
2510                         return retval;
2511
2512                 target = target->next;
2513         }
2514
2515         return ERROR_OK;
2516 }
2517
2518 COMMAND_HANDLER(handle_gdb_sync_command)
2519 {
2520         if (CMD_ARGC != 0)
2521         {
2522                 return ERROR_COMMAND_SYNTAX_ERROR;
2523         }
2524
2525         if (current_gdb_connection == NULL)
2526         {
2527                 command_print(CMD_CTX,
2528                                 "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
2529                 return ERROR_FAIL;
2530         }
2531
2532         current_gdb_connection->sync = true;
2533
2534         return ERROR_OK;
2535 }
2536
2537 /* daemon configuration command gdb_port */
2538 COMMAND_HANDLER(handle_gdb_port_command)
2539 {
2540         int retval = CALL_COMMAND_HANDLER(server_pipe_command, &gdb_port);
2541         if (ERROR_OK == retval) {
2542                 free((void*)gdb_port_next);
2543                 gdb_port_next = strdup(gdb_port);
2544         }
2545         return retval;
2546 }
2547
2548 COMMAND_HANDLER(handle_gdb_memory_map_command)
2549 {
2550         if (CMD_ARGC != 1)
2551                 return ERROR_COMMAND_SYNTAX_ERROR;
2552
2553         COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_memory_map);
2554         return ERROR_OK;
2555 }
2556
2557 COMMAND_HANDLER(handle_gdb_flash_program_command)
2558 {
2559         if (CMD_ARGC != 1)
2560                 return ERROR_COMMAND_SYNTAX_ERROR;
2561
2562         COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_flash_program);
2563         return ERROR_OK;
2564 }
2565
2566 COMMAND_HANDLER(handle_gdb_report_data_abort_command)
2567 {
2568         if (CMD_ARGC != 1)
2569                 return ERROR_COMMAND_SYNTAX_ERROR;
2570
2571         COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_data_abort);
2572         return ERROR_OK;
2573 }
2574
2575 /* gdb_breakpoint_override */
2576 COMMAND_HANDLER(handle_gdb_breakpoint_override_command)
2577 {
2578         if (CMD_ARGC == 0)
2579         {
2580
2581         } else if (CMD_ARGC == 1)
2582         {
2583                 gdb_breakpoint_override = 1;
2584                 if (strcmp(CMD_ARGV[0], "hard") == 0)
2585                 {
2586                         gdb_breakpoint_override_type = BKPT_HARD;
2587                 } else if (strcmp(CMD_ARGV[0], "soft") == 0)
2588                 {
2589                         gdb_breakpoint_override_type = BKPT_SOFT;
2590                 } else if (strcmp(CMD_ARGV[0], "disable") == 0)
2591                 {
2592                         gdb_breakpoint_override = 0;
2593                 }
2594         } else
2595         {
2596                 return ERROR_COMMAND_SYNTAX_ERROR;
2597         }
2598         if (gdb_breakpoint_override)
2599         {
2600                 LOG_USER("force %s breakpoints", (gdb_breakpoint_override_type == BKPT_HARD)?"hard":"soft");
2601         } else
2602         {
2603                 LOG_USER("breakpoint type is not overridden");
2604         }
2605
2606         return ERROR_OK;
2607 }
2608
2609 static const struct command_registration gdb_command_handlers[] = {
2610         {
2611                 .name = "gdb_sync",
2612                 .handler = handle_gdb_sync_command,
2613                 .mode = COMMAND_ANY,
2614                 .help = "next stepi will return immediately allowing "
2615                         "GDB to fetch register state without affecting "
2616                         "target state",
2617         },
2618         {
2619                 .name = "gdb_port",
2620                 .handler = handle_gdb_port_command,
2621                 .mode = COMMAND_ANY,
2622                 .help = "Normally gdb listens to a TCP/IP port. Each subsequent GDB "
2623                                 "server listens for the next port number after the "
2624                                 "base port number specified. "
2625                                 "No arguments reports GDB port. \"pipe\" means listen to stdin "
2626                                 "output to stdout, an integer is base port number, \"disable\" disables "
2627                                 "port. Any other string is are interpreted as named pipe to listen to. "
2628                                 "Output pipe is the same name as input pipe, but with 'o' appended.",
2629                 .usage = "[port_num]",
2630         },
2631         {
2632                 .name = "gdb_memory_map",
2633                 .handler = handle_gdb_memory_map_command,
2634                 .mode = COMMAND_CONFIG,
2635                 .help = "enable or disable memory map",
2636                 .usage = "('enable'|'disable')"
2637         },
2638         {
2639                 .name = "gdb_flash_program",
2640                 .handler = handle_gdb_flash_program_command,
2641                 .mode = COMMAND_CONFIG,
2642                 .help = "enable or disable flash program",
2643                 .usage = "('enable'|'disable')"
2644         },
2645         {
2646                 .name = "gdb_report_data_abort",
2647                 .handler = handle_gdb_report_data_abort_command,
2648                 .mode = COMMAND_CONFIG,
2649                 .help = "enable or disable reporting data aborts",
2650                 .usage = "('enable'|'disable')"
2651         },
2652         {
2653                 .name = "gdb_breakpoint_override",
2654                 .handler = handle_gdb_breakpoint_override_command,
2655                 .mode = COMMAND_ANY,
2656                 .help = "Display or specify type of breakpoint "
2657                         "to be used by gdb 'break' commands.",
2658                 .usage = "('hard'|'soft'|'disable')"
2659         },
2660         COMMAND_REGISTRATION_DONE
2661 };
2662
2663 int gdb_register_commands(struct command_context *cmd_ctx)
2664 {
2665         gdb_port = strdup("3333");
2666         gdb_port_next = strdup("3333");
2667         return register_commands(cmd_ctx, NULL, gdb_command_handlers);
2668 }