This commit was generated by cvs2svn to track changes on a CVS vendor
[external/binutils.git] / 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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   char *name;                   /* The name of the device or host */
40   struct _serial_t *next;       /* Pointer to the next serial_t */
41   int refcnt;                   /* Number of pointers to this block */
42 };
43
44 typedef struct _serial_t *serial_t;
45
46 struct serial_ops {
47   char *name;
48   struct serial_ops *next;
49   int (*open) PARAMS ((serial_t, const char *name));
50   void (*close) PARAMS ((serial_t));
51   int (*readchar) PARAMS ((serial_t, int timeout));
52   int (*write) PARAMS ((serial_t, const char *str, int len));
53   /* Discard pending output */
54   int (*flush_output) PARAMS ((serial_t));
55   /* Discard pending input */
56   int (*flush_input) PARAMS ((serial_t));
57   int (*send_break) PARAMS ((serial_t));
58   void (*go_raw) PARAMS ((serial_t));
59   serial_ttystate (*get_tty_state) PARAMS ((serial_t));
60   int (*set_tty_state) PARAMS ((serial_t, serial_ttystate));
61   void (*print_tty_state) PARAMS ((serial_t, serial_ttystate));
62   int (*noflush_set_tty_state)
63     PARAMS ((serial_t, serial_ttystate, serial_ttystate));
64   int (*setbaudrate) PARAMS ((serial_t, int rate));
65   int (*setstopbits) PARAMS ((serial_t, int num));
66   /* Wait for output to drain */
67   int (*drain_output) PARAMS ((serial_t));
68 };
69
70 /* Add a new serial interface to the interface list */
71
72 void serial_add_interface PARAMS ((struct serial_ops *optable));
73
74 serial_t serial_open PARAMS ((const char *name));
75
76 serial_t serial_fdopen PARAMS ((const int fd));
77
78 /* For most routines, if a failure is indicated, then errno should be
79    examined.  */
80
81 /* Try to open NAME.  Returns a new serial_t on success, NULL on failure.
82  */
83
84 #define SERIAL_OPEN(NAME) serial_open(NAME)
85
86 /* Open a new serial stream using a file handle.  */
87
88 #define SERIAL_FDOPEN(FD) serial_fdopen(FD)
89
90 /* Allow pending output to drain. */
91
92 #define SERIAL_DRAIN_OUTPUT(SERIAL_T) \
93   ((SERIAL_T)->ops->drain_output((SERIAL_T)))
94   
95 /* Flush (discard) pending output.  Might also flush input (if this system can't flush
96    only output).  */
97
98 #define SERIAL_FLUSH_OUTPUT(SERIAL_T) \
99   ((SERIAL_T)->ops->flush_output((SERIAL_T)))
100
101 /* Flush pending input.  Might also flush output (if this system can't flush
102    only input).  */
103
104 #define SERIAL_FLUSH_INPUT(SERIAL_T)\
105   ((*(SERIAL_T)->ops->flush_input) ((SERIAL_T)))
106
107 /* Send a break between 0.25 and 0.5 seconds long.  */
108
109 extern int serial_send_break PARAMS ((serial_t scb));
110
111 #define SERIAL_SEND_BREAK(SERIAL_T) serial_send_break (SERIAL_T)
112
113 /* Turn the port into raw mode. */
114
115 #define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
116
117 /* Return a pointer to a newly malloc'd ttystate containing the state
118    of the tty.  */
119 #define SERIAL_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
120
121 /* Set the state of the tty to TTYSTATE.  The change is immediate.
122    When changing to or from raw mode, input might be discarded.
123    Returns 0 for success, negative value for error (in which case errno
124    contains the error).  */
125 #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
126
127 /* printf_filtered a user-comprehensible description of ttystate.  */
128 #define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE) \
129   ((*((SERIAL_T)->ops->print_tty_state)) ((SERIAL_T), (TTYSTATE)))
130
131 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
132    current state (generally obtained from a recent call to
133    SERIAL_GET_TTY_STATE), but be careful not to discard any input.
134    This means that we never switch in or out of raw mode, even
135    if NEW_TTYSTATE specifies a switch.  */
136 #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \
137   ((*((SERIAL_T)->ops->noflush_set_tty_state)) \
138     ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE)))
139
140 /* Read one char from the serial device with TIMEOUT seconds to wait
141    or -1 to wait forever.  Use timeout of 0 to effect a poll. Returns
142    char if ok, else one of the following codes.  Note that all error
143    codes are guaranteed to be < 0.  */
144
145 #define SERIAL_ERROR -1         /* General error, see errno for details */
146 #define SERIAL_TIMEOUT -2
147 #define SERIAL_EOF -3
148
149 extern int serial_readchar PARAMS ((serial_t scb, int timeout));
150
151 #define SERIAL_READCHAR(SERIAL_T, TIMEOUT)  serial_readchar (SERIAL_T, TIMEOUT)
152
153 /* Set the baudrate to the decimal value supplied.  Returns 0 for success,
154    -1 for failure.  */
155
156 #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
157
158 /* Set the number of stop bits to the value specified.  Returns 0 for success,
159    -1 for failure.  */
160
161 #define SERIAL_1_STOPBITS 1
162 #define SERIAL_1_AND_A_HALF_STOPBITS 2 /* 1.5 bits, snicker... */
163 #define SERIAL_2_STOPBITS 3
164
165 #define SERIAL_SETSTOPBITS(SERIAL_T, NUM) ((SERIAL_T)->ops->setstopbits((SERIAL_T), NUM))
166
167 /* Write LEN chars from STRING to the port SERIAL_T.  Returns 0 for
168    success, non-zero for failure.  */
169
170 extern int serial_write PARAMS ((serial_t scb, const char *str, int len));
171
172 #define SERIAL_WRITE(SERIAL_T, STRING,LEN)  serial_write (SERIAL_T, STRING, LEN)
173
174 /* Push out all buffers, close the device and destroy SERIAL_T. */
175
176 extern void serial_close PARAMS ((serial_t, int));
177
178 #define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T, 1)
179
180 /* Push out all buffers and destroy SERIAL_T without closing the device.  */
181
182 #define SERIAL_UN_FDOPEN(SERIAL_T) serial_close(SERIAL_T, 0)
183
184 extern void serial_printf PARAMS ((serial_t desc, const char *, ...))
185      ATTR_FORMAT(printf, 2, 3);
186
187 /* File in which to record the remote debugging session */
188
189 extern void serial_log_command PARAMS ((const char *));
190
191 #endif /* SERIAL_H */