gdb/remote.h

   1 /* Remote target communications for serial-line targets in custom GDB protocol
   2    Copyright (C) 1999-2020 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef REMOTE_H
  20 #define REMOTE_H
  21
  22 #include "remote-notif.h"
  23
  24 struct target_desc;
  25 struct remote_target;
  26
  27 /* Read a packet from the remote machine, with error checking, and
  28    store it in *BUF.  Resize *BUF using xrealloc if necessary to hold
  29    the result, and update *SIZEOF_BUF.  If FOREVER, wait forever
  30    rather than timing out; this is used (in synchronous mode) to wait
  31    for a target that is is executing user code to stop.  */
  32
  33 extern void getpkt (remote_target *remote,
  34                     char **buf, long *sizeof_buf, int forever);
  35
  36 /* Send a packet to the remote machine, with error checking.  The data
  37    of the packet is in BUF.  The string in BUF can be at most PBUFSIZ
  38    - 5 to account for the $, # and checksum, and for a possible /0 if
  39    we are debugging (remote_debug) and want to print the sent packet
  40    as a string.  */
  41
  42 extern int putpkt (remote_target *remote, const char *buf);
  43
  44 void register_remote_g_packet_guess (struct gdbarch *gdbarch, int bytes,
  45                                      const struct target_desc *tdesc);
  46 void register_remote_support_xml (const char *);
  47
  48 void remote_file_put (const char *local_file, const char *remote_file,
  49                       int from_tty);
  50 void remote_file_get (const char *remote_file, const char *local_file,
  51                       int from_tty);
  52 void remote_file_delete (const char *remote_file, int from_tty);
  53
  54 extern int remote_register_number_and_offset (struct gdbarch *gdbarch,
  55                                               int regnum, int *pnum,
  56                                               int *poffset);
  57
  58 extern void remote_notif_get_pending_events (remote_target *remote,
  59                                              struct notif_client *np);
  60 #endif