home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 9 / FreshFishVol9-CD2.bin / bbs / gnu / gdb-4.14-src.lha / gdb-4.14 / gdb / serial.h < prev    next >
Encoding:
C/C++ Source or Header  |  1994-01-30  |  5.6 KB  |  159 lines
  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. #ifndef SERIAL_H
  21. #define SERIAL_H
  22.  
  23. /* Terminal state pointer.  This is specific to each type of interface. */
  24.  
  25. typedef PTR serial_ttystate;
  26.  
  27. struct _serial_t
  28. {
  29.   int fd;            /* File descriptor */
  30.   struct serial_ops *ops;    /* Function vector */
  31.   serial_ttystate ttystate;    /* Not used (yet) */
  32.   int bufcnt;            /* Amount of data in receive buffer */
  33.   unsigned char *bufp;        /* Current byte */
  34.   unsigned char buf[BUFSIZ];    /* Da buffer itself */
  35.   int current_timeout;        /* (termio{s} only), last value of VTIME */
  36.   /* ser-unix.c termio{,s} only, we still need to wait for this many more
  37.      seconds.  */
  38.   int timeout_remaining;
  39. };
  40.  
  41. typedef struct _serial_t *serial_t;
  42.  
  43. struct serial_ops {
  44.   char *name;
  45.   struct serial_ops *next;
  46.   int (*open) PARAMS ((serial_t, const char *name));
  47.   void (*close) PARAMS ((serial_t));
  48.   int (*readchar) PARAMS ((serial_t, int timeout));
  49.   int (*write) PARAMS ((serial_t, const char *str, int len));
  50.   int (*flush_output) PARAMS ((serial_t));
  51.   int (*flush_input) PARAMS ((serial_t));
  52.   int (*send_break) PARAMS ((serial_t));
  53.   void (*go_raw) PARAMS ((serial_t));
  54.   serial_ttystate (*get_tty_state) PARAMS ((serial_t));
  55.   int (*set_tty_state) PARAMS ((serial_t, serial_ttystate));
  56.   void (*print_tty_state) PARAMS ((serial_t, serial_ttystate));
  57.   int (*noflush_set_tty_state)
  58.     PARAMS ((serial_t, serial_ttystate, serial_ttystate));
  59.   int (*setbaudrate) PARAMS ((serial_t, int rate));
  60. };
  61.  
  62. /* Add a new serial interface to the interface list */
  63.  
  64. void serial_add_interface PARAMS ((struct serial_ops *optable));
  65.  
  66. serial_t serial_open PARAMS ((const char *name));
  67.  
  68. serial_t serial_fdopen PARAMS ((const int fd));
  69.  
  70. /* For most routines, if a failure is indicated, then errno should be
  71.    examined.  */
  72.  
  73. /* Try to open NAME.  Returns a new serial_t on success, NULL on failure.
  74.  */
  75.  
  76. #define SERIAL_OPEN(NAME) serial_open(NAME)
  77.  
  78. /* Open a new serial stream using a file handle.  */
  79.  
  80. #define SERIAL_FDOPEN(FD) serial_fdopen(FD)
  81.  
  82. /* Flush pending output.  Might also flush input (if this system can't flush
  83.    only output).  */
  84.  
  85. #define SERIAL_FLUSH_OUTPUT(SERIAL_T) \
  86.   ((SERIAL_T)->ops->flush_output((SERIAL_T)))
  87.  
  88. /* Flush pending input.  Might also flush output (if this system can't flush
  89.    only input).  */
  90.  
  91. #define SERIAL_FLUSH_INPUT(SERIAL_T)\
  92.   ((*(SERIAL_T)->ops->flush_input) ((SERIAL_T)))
  93.  
  94. /* Send a break between 0.25 and 0.5 seconds long.  */
  95.  
  96. #define SERIAL_SEND_BREAK(SERIAL_T) \
  97.   ((*(SERIAL_T)->ops->send_break) (SERIAL_T))
  98.  
  99. /* Turn the port into raw mode. */
  100.  
  101. #define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
  102.  
  103. /* Return a pointer to a newly malloc'd ttystate containing the state
  104.    of the tty.  */
  105. #define SERIAL_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
  106.  
  107. /* Set the state of the tty to TTYSTATE.  The change is immediate.
  108.    When changing to or from raw mode, input might be discarded.
  109.    Returns 0 for success, negative value for error (in which case errno
  110.    contains the error).  */
  111. #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
  112.  
  113. /* printf_filtered a user-comprehensible description of ttystate.  */
  114. #define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE) \
  115.   ((*((SERIAL_T)->ops->print_tty_state)) ((SERIAL_T), (TTYSTATE)))
  116.  
  117. /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
  118.    current state (generally obtained from a recent call to
  119.    SERIAL_GET_TTY_STATE), but be careful not to discard any input.
  120.    This means that we never switch in or out of raw mode, even
  121.    if NEW_TTYSTATE specifies a switch.  */
  122. #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \
  123.   ((*((SERIAL_T)->ops->noflush_set_tty_state)) \
  124.     ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE)))
  125.  
  126. /* Read one char from the serial device with TIMEOUT seconds to wait
  127.    or -1 to wait forever.  Use timeout of 0 to effect a poll. Returns
  128.    char if ok, else one of the following codes.  Note that all error
  129.    codes are guaranteed to be < 0.  */
  130.  
  131. #define SERIAL_ERROR -1        /* General error, see errno for details */
  132. #define SERIAL_TIMEOUT -2
  133. #define SERIAL_EOF -3
  134.  
  135. #define SERIAL_READCHAR(SERIAL_T, TIMEOUT) ((SERIAL_T)->ops->readchar((SERIAL_T), TIMEOUT))
  136.  
  137. /* Set the baudrate to the decimal value supplied.  Returns 0 for success,
  138.    -1 for failure.  */
  139.  
  140. #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
  141.  
  142. /* Write LEN chars from STRING to the port SERIAL_T.  Returns 0 for
  143.    success, non-zero for failure.  */
  144.  
  145. #define SERIAL_WRITE(SERIAL_T, STRING, LEN) ((SERIAL_T)->ops->write((SERIAL_T), STRING, LEN))
  146.  
  147. /* Push out all buffers, close the device and destroy SERIAL_T. */
  148.  
  149. void serial_close PARAMS ((serial_t));
  150.  
  151. #define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T)
  152.  
  153. /* Destroy SERIAL_T without doing the rest of the stuff that SERIAL_CLOSE
  154.    does.  */
  155.  
  156. #define SERIAL_UN_FDOPEN(SERIAL_T) (free (SERIAL_T))
  157.  
  158. #endif /* SERIAL_H */
  159.