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 ttystate;
  23
  24 struct _serial_t
  25 {
  26   int fd;
  27   struct serial_ops *ops;
  28   ttystate ttystate;
  29   int bufcnt;
  30   unsigned char *bufp;
  31   unsigned char buf[BUFSIZ];
  32 };
  33
  34 typedef struct _serial_t *serial_t;
  35
  36 struct serial_ops {
  37   char *name;
  38   struct serial_ops *next;
  39   int (*open) PARAMS ((serial_t, const char *name));
  40   void (*close) PARAMS ((serial_t));
  41   int (*readchar) PARAMS ((serial_t, int timeout));
  42   int (*write) PARAMS ((serial_t, const char *str, int len));
  43   void (*go_raw) PARAMS ((serial_t));
  44   void (*restore) PARAMS ((serial_t));
  45   int (*setbaudrate) PARAMS ((serial_t, int rate));
  46 };
  47
  48 /* Add a new serial interface to the interface list */
  49
  50 void serial_add_interface PARAMS ((struct serial_ops *optable));
  51
  52 serial_t serial_open PARAMS ((const char *name));
  53
  54 /* For most routines, if a failure is indicated, then errno should be
  55    examined.  */
  56
  57 /* Try to open NAME.  Returns a new serial_t on success, NULL on failure.
  58  */
  59
  60 #define SERIAL_OPEN(NAME) serial_open(NAME)
  61
  62 /* Turn the port into raw mode. */
  63
  64 #define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
  65
  66 /* Read one char from the serial device with TIMEOUT seconds timeout.
  67    Returns char if ok, else one of the following codes.  Note that all
  68    error codes are guaranteed to be < 0.  */
  69
  70 #define SERIAL_ERROR -1         /* General error, see errno for details */
  71 #define SERIAL_TIMEOUT -2
  72 #define SERIAL_EOF -3
  73
  74 #define SERIAL_READCHAR(SERIAL_T, TIMEOUT) ((SERIAL_T)->ops->readchar((SERIAL_T), TIMEOUT))
  75
  76 /* Set the baudrate to the decimal value supplied.  Returns 0 for success,
  77    -1 for failure.  */
  78
  79 #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
  80
  81 /* Write LEN chars from STRING to the port SERIAL_T.  Returns 0 for success,
  82    -1 for failure.  */
  83
  84 #define SERIAL_WRITE(SERIAL_T, STRING, LEN) ((SERIAL_T)->ops->write((SERIAL_T), STRING, LEN))
  85
  86 /* Push out all buffers, close the device and destroy SERIAL_T. */
  87
  88 void serial_close PARAMS ((serial_t));
  89
  90 #define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T)
  91
  92 /* Restore the serial port to the state saved in oldstate.  XXX - currently
  93    unused! */
  94
  95 #define SERIAL_RESTORE(SERIAL_T) (SERIAL_T)->ops->restore((SERIAL_T))