gdb/serial.h

   1 /* Remote serial support interface definitions for GDB, the GNU Debugger.
   2    Copyright 1992, 1993 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 2 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, write to the Free Software
  18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 /* Terminal state pointer.  This is specific to each type of interface. */
  21
  22 typedef PTR serial_ttystate;
  23
  24 struct _serial_t
  25 {
  26   int fd;                       /* File descriptor */
  27   struct serial_ops *ops;       /* Function vector */
  28   serial_ttystate ttystate;     /* Not used (yet) */
  29   int bufcnt;                   /* Amount of data in receive buffer */
  30   unsigned char *bufp;          /* Current byte */
  31   unsigned char buf[BUFSIZ];    /* Da buffer itself */
  32   int current_timeout;          /* (termio{s} only), last value of VTIME */
  33 };
  34
  35 typedef struct _serial_t *serial_t;
  36
  37 struct serial_ops {
  38   char *name;
  39   struct serial_ops *next;
  40   int (*open) PARAMS ((serial_t, const char *name));
  41   void (*close) PARAMS ((serial_t));
  42   int (*readchar) PARAMS ((serial_t, int timeout));
  43   int (*write) PARAMS ((serial_t, const char *str, int len));
  44   int (*flush_output) PARAMS ((serial_t));
  45   void (*go_raw) PARAMS ((serial_t));
  46   serial_ttystate (*get_tty_state) PARAMS ((serial_t));
  47   int (*set_tty_state) PARAMS ((serial_t, serial_ttystate));
  48   void (*print_tty_state) PARAMS ((serial_t, serial_ttystate));
  49   int (*noflush_set_tty_state)
  50     PARAMS ((serial_t, serial_ttystate, serial_ttystate));
  51   int (*setbaudrate) PARAMS ((serial_t, int rate));
  52   int (*set_process_group) PARAMS ((serial_t, serial_ttystate, int));
  53 };
  54
  55 /* Add a new serial interface to the interface list */
  56
  57 void serial_add_interface PARAMS ((struct serial_ops *optable));
  58
  59 serial_t serial_open PARAMS ((const char *name));
  60
  61 serial_t serial_fdopen PARAMS ((int fd));
  62
  63 /* For most routines, if a failure is indicated, then errno should be
  64    examined.  */
  65
  66 /* Try to open NAME.  Returns a new serial_t on success, NULL on failure.
  67  */
  68
  69 #define SERIAL_OPEN(NAME) serial_open(NAME)
  70
  71 /* Open a new serial stream using a file handle.  */
  72
  73 #define SERIAL_FDOPEN(FD) serial_fdopen(FD)
  74
  75 /* Flush pending output.  */
  76
  77 #define SERIAL_FLUSH_OUTPUT(SERIAL_T) \
  78   ((SERIAL_T)->ops->flush_output((SERIAL_T)))
  79
  80 /* Turn the port into raw mode. */
  81
  82 #define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
  83
  84 /* Return a pointer to a newly malloc'd ttystate containing the state
  85    of the tty.  */
  86 #define SERIAL_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
  87
  88 /* Set the state of the tty to TTYSTATE.  The change is immediate.
  89    When changing to or from raw mode, input might be discarded.  */
  90 #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
  91
  92 /* printf_filtered a user-comprehensible description of ttystate.  */
  93 #define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE) \
  94   ((*((SERIAL_T)->ops->print_tty_state)) ((SERIAL_T), (TTYSTATE)))
  95
  96 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
  97    current state (generally obtained from a recent call to
  98    SERIAL_GET_TTY_STATE), but be careful not to discard any input.
  99    This means that we never switch in or out of raw mode, even
 100    if NEW_TTYSTATE specifies a switch.  */
 101 #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \
 102   ((*((SERIAL_T)->ops->noflush_set_tty_state)) \
 103     ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE)))
 104
 105 /* Read one char from the serial device with TIMEOUT seconds timeout.
 106    Returns char if ok, else one of the following codes.  Note that all
 107    error codes are guaranteed to be < 0.  */
 108
 109 #define SERIAL_ERROR -1         /* General error, see errno for details */
 110 #define SERIAL_TIMEOUT -2
 111 #define SERIAL_EOF -3
 112
 113 #define SERIAL_READCHAR(SERIAL_T, TIMEOUT) ((SERIAL_T)->ops->readchar((SERIAL_T), TIMEOUT))
 114
 115 /* Set the baudrate to the decimal value supplied.  Returns 0 for success,
 116    -1 for failure.  */
 117
 118 #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
 119
 120 /* Write LEN chars from STRING to the port SERIAL_T.  Returns 0 for success,
 121    -1 for failure.  */
 122
 123 #define SERIAL_WRITE(SERIAL_T, STRING, LEN) ((SERIAL_T)->ops->write((SERIAL_T), STRING, LEN))
 124
 125 /* Push out all buffers, close the device and destroy SERIAL_T. */
 126
 127 void serial_close PARAMS ((serial_t));
 128
 129 #define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T)
 130
 131 /* Destroy SERIAL_T without doing the rest of the stuff that SERIAL_CLOSE
 132    does.  */
 133
 134 #define SERIAL_UN_FDOPEN(SERIAL_T) (free (SERIAL_T))
 135
 136 /* Set the process group saved in TTYSTATE to GROUP.  This just modifies
 137    the ttystate setting; need to call SERIAL_SET_TTY_STATE for this to
 138    actually have any effect.  If no job control, then don't do anything.  */
 139 #define SERIAL_SET_PROCESS_GROUP(SERIAL_T, TTYSTATE, GROUP) \
 140   ((*((SERIAL_T)->ops->set_process_group)) (SERIAL_T, TTYSTATE, GROUP))
 141
 142 /* Do we have job control?  Can be assumed to always be the same within
 143    a given run of GDB.  In ser-unix.c, ser-go32.c, etc.  */
 144 extern int job_control;
 145
 146 /* Set the process group of the caller to its own pid, or do nothing if
 147    we lack job control.  */
 148 extern int gdb_setpgid PARAMS ((void));