gcc lint
[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., 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   int (*flush_input) PARAMS ((serial_t));
46   int (*send_break) PARAMS ((serial_t));
47   void (*go_raw) PARAMS ((serial_t));
48   serial_ttystate (*get_tty_state) PARAMS ((serial_t));
49   int (*set_tty_state) PARAMS ((serial_t, serial_ttystate));
50   void (*print_tty_state) PARAMS ((serial_t, serial_ttystate));
51   int (*noflush_set_tty_state)
52     PARAMS ((serial_t, serial_ttystate, serial_ttystate));
53   int (*setbaudrate) PARAMS ((serial_t, int rate));
54   int (*set_process_group) PARAMS ((serial_t, serial_ttystate, int));
55 };
56
57 /* Add a new serial interface to the interface list */
58
59 void serial_add_interface PARAMS ((struct serial_ops *optable));
60
61 serial_t serial_open PARAMS ((const char *name));
62
63 serial_t serial_fdopen PARAMS ((int fd));
64
65 /* For most routines, if a failure is indicated, then errno should be
66    examined.  */
67
68 /* Try to open NAME.  Returns a new serial_t on success, NULL on failure.
69  */
70
71 #define SERIAL_OPEN(NAME) serial_open(NAME)
72
73 /* Open a new serial stream using a file handle.  */
74
75 #define SERIAL_FDOPEN(FD) serial_fdopen(FD)
76
77 /* Flush pending output.  Might also flush input (if this system can't flush
78    only output).  */
79
80 #define SERIAL_FLUSH_OUTPUT(SERIAL_T) \
81   ((SERIAL_T)->ops->flush_output((SERIAL_T)))
82
83 /* Flush pending input.  Might also flush output (if this system can't flush
84    only input).  */
85
86 #define SERIAL_FLUSH_INPUT(SERIAL_T)\
87   ((*(SERIAL_T)->ops->flush_input) ((SERIAL_T)))
88
89 /* Send a break between 0.25 and 0.5 seconds long.  */
90
91 #define SERIAL_SEND_BREAK(SERIAL_T) \
92   ((*(SERIAL_T)->ops->send_break) (SERIAL_T))
93
94 /* Turn the port into raw mode. */
95
96 #define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
97
98 /* Return a pointer to a newly malloc'd ttystate containing the state
99    of the tty.  */
100 #define SERIAL_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
101
102 /* Set the state of the tty to TTYSTATE.  The change is immediate.
103    When changing to or from raw mode, input might be discarded.  */
104 #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
105
106 /* printf_filtered a user-comprehensible description of ttystate.  */
107 #define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE) \
108   ((*((SERIAL_T)->ops->print_tty_state)) ((SERIAL_T), (TTYSTATE)))
109
110 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
111    current state (generally obtained from a recent call to
112    SERIAL_GET_TTY_STATE), but be careful not to discard any input.
113    This means that we never switch in or out of raw mode, even
114    if NEW_TTYSTATE specifies a switch.  */
115 #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \
116   ((*((SERIAL_T)->ops->noflush_set_tty_state)) \
117     ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE)))
118
119 /* Read one char from the serial device with TIMEOUT seconds to wait
120    or -1 to wait forever.  Use timeout of 0 to effect a poll. Returns
121    char if ok, else one of the following codes.  Note that all error
122    codes are guaranteed to be < 0.  */
123
124 #define SERIAL_ERROR -1         /* General error, see errno for details */
125 #define SERIAL_TIMEOUT -2
126 #define SERIAL_EOF -3
127
128 #define SERIAL_READCHAR(SERIAL_T, TIMEOUT) ((SERIAL_T)->ops->readchar((SERIAL_T), TIMEOUT))
129
130 /* Set the baudrate to the decimal value supplied.  Returns 0 for success,
131    -1 for failure.  */
132
133 #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
134
135 /* Write LEN chars from STRING to the port SERIAL_T.  Returns 0 for
136    success, non-zero for failure.  */
137
138 #define SERIAL_WRITE(SERIAL_T, STRING, LEN) ((SERIAL_T)->ops->write((SERIAL_T), STRING, LEN))
139
140 /* Push out all buffers, close the device and destroy SERIAL_T. */
141
142 void serial_close PARAMS ((serial_t));
143
144 #define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T)
145
146 /* Destroy SERIAL_T without doing the rest of the stuff that SERIAL_CLOSE
147    does.  */
148
149 #define SERIAL_UN_FDOPEN(SERIAL_T) (free (SERIAL_T))
150
151 /* Set the process group saved in TTYSTATE to GROUP.  This just modifies
152    the ttystate setting; need to call SERIAL_SET_TTY_STATE for this to
153    actually have any effect.  If no job control, then don't do anything.  */
154 #define SERIAL_SET_PROCESS_GROUP(SERIAL_T, TTYSTATE, GROUP) \
155   ((*((SERIAL_T)->ops->set_process_group)) (SERIAL_T, TTYSTATE, GROUP))
156
157 /* Do we have job control?  Can be assumed to always be the same within
158    a given run of GDB.  In ser-unix.c, ser-go32.c, etc.  */
159 extern int job_control;
160
161 /* Set the process group of the caller to its own pid, or do nothing if
162    we lack job control.  */
163 extern int gdb_setpgid PARAMS ((void));