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