1 /* Remote serial support interface definitions for GDB, the GNU Debugger.
2 Copyright 1992, 1993 Free Software Foundation, Inc.
4 This file is part of GDB.
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.
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.
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. */
23 /* Terminal state pointer. This is specific to each type of interface. */
25 typedef PTR serial_ttystate
;
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 */
38 typedef struct _serial_t
*serial_t
;
42 struct serial_ops
*next
;
43 int (*open
) PARAMS ((serial_t
, const char *name
));
44 void (*close
) PARAMS ((serial_t
));
45 int (*readchar
) PARAMS ((serial_t
, int timeout
));
46 int (*write
) PARAMS ((serial_t
, const char *str
, int len
));
47 int (*flush_output
) PARAMS ((serial_t
));
48 int (*flush_input
) PARAMS ((serial_t
));
49 int (*send_break
) PARAMS ((serial_t
));
50 void (*go_raw
) PARAMS ((serial_t
));
51 serial_ttystate (*get_tty_state
) PARAMS ((serial_t
));
52 int (*set_tty_state
) PARAMS ((serial_t
, serial_ttystate
));
53 void (*print_tty_state
) PARAMS ((serial_t
, serial_ttystate
));
54 int (*noflush_set_tty_state
)
55 PARAMS ((serial_t
, serial_ttystate
, serial_ttystate
));
56 int (*setbaudrate
) PARAMS ((serial_t
, int rate
));
57 int (*set_process_group
) PARAMS ((serial_t
, serial_ttystate
, int));
60 /* Add a new serial interface to the interface list */
62 void serial_add_interface
PARAMS ((struct serial_ops
*optable
));
64 serial_t serial_open
PARAMS ((const char *name
));
66 serial_t serial_fdopen
PARAMS ((int fd
));
68 /* For most routines, if a failure is indicated, then errno should be
71 /* Try to open NAME. Returns a new serial_t on success, NULL on failure.
74 #define SERIAL_OPEN(NAME) serial_open(NAME)
76 /* Open a new serial stream using a file handle. */
78 #define SERIAL_FDOPEN(FD) serial_fdopen(FD)
80 /* Flush pending output. Might also flush input (if this system can't flush
83 #define SERIAL_FLUSH_OUTPUT(SERIAL_T) \
84 ((SERIAL_T)->ops->flush_output((SERIAL_T)))
86 /* Flush pending input. Might also flush output (if this system can't flush
89 #define SERIAL_FLUSH_INPUT(SERIAL_T)\
90 ((*(SERIAL_T)->ops->flush_input) ((SERIAL_T)))
92 /* Send a break between 0.25 and 0.5 seconds long. */
94 #define SERIAL_SEND_BREAK(SERIAL_T) \
95 ((*(SERIAL_T)->ops->send_break) (SERIAL_T))
97 /* Turn the port into raw mode. */
99 #define SERIAL_RAW(SERIAL_T) (SERIAL_T)->ops->go_raw((SERIAL_T))
101 /* Return a pointer to a newly malloc'd ttystate containing the state
103 #define SERIAL_GET_TTY_STATE(SERIAL_T) (SERIAL_T)->ops->get_tty_state((SERIAL_T))
105 /* Set the state of the tty to TTYSTATE. The change is immediate.
106 When changing to or from raw mode, input might be discarded. */
107 #define SERIAL_SET_TTY_STATE(SERIAL_T, TTYSTATE) (SERIAL_T)->ops->set_tty_state((SERIAL_T), (TTYSTATE))
109 /* printf_filtered a user-comprehensible description of ttystate. */
110 #define SERIAL_PRINT_TTY_STATE(SERIAL_T, TTYSTATE) \
111 ((*((SERIAL_T)->ops->print_tty_state)) ((SERIAL_T), (TTYSTATE)))
113 /* Set the tty state to NEW_TTYSTATE, where OLD_TTYSTATE is the
114 current state (generally obtained from a recent call to
115 SERIAL_GET_TTY_STATE), but be careful not to discard any input.
116 This means that we never switch in or out of raw mode, even
117 if NEW_TTYSTATE specifies a switch. */
118 #define SERIAL_NOFLUSH_SET_TTY_STATE(SERIAL_T, NEW_TTYSTATE, OLD_TTYSTATE) \
119 ((*((SERIAL_T)->ops->noflush_set_tty_state)) \
120 ((SERIAL_T), (NEW_TTYSTATE), (OLD_TTYSTATE)))
122 /* Read one char from the serial device with TIMEOUT seconds to wait
123 or -1 to wait forever. Use timeout of 0 to effect a poll. Returns
124 char if ok, else one of the following codes. Note that all error
125 codes are guaranteed to be < 0. */
127 #define SERIAL_ERROR -1 /* General error, see errno for details */
128 #define SERIAL_TIMEOUT -2
129 #define SERIAL_EOF -3
131 #define SERIAL_READCHAR(SERIAL_T, TIMEOUT) ((SERIAL_T)->ops->readchar((SERIAL_T), TIMEOUT))
133 /* Set the baudrate to the decimal value supplied. Returns 0 for success,
136 #define SERIAL_SETBAUDRATE(SERIAL_T, RATE) ((SERIAL_T)->ops->setbaudrate((SERIAL_T), RATE))
138 /* Write LEN chars from STRING to the port SERIAL_T. Returns 0 for
139 success, non-zero for failure. */
141 #define SERIAL_WRITE(SERIAL_T, STRING, LEN) ((SERIAL_T)->ops->write((SERIAL_T), STRING, LEN))
143 /* Push out all buffers, close the device and destroy SERIAL_T. */
145 void serial_close
PARAMS ((serial_t
));
147 #define SERIAL_CLOSE(SERIAL_T) serial_close(SERIAL_T)
149 /* Destroy SERIAL_T without doing the rest of the stuff that SERIAL_CLOSE
152 #define SERIAL_UN_FDOPEN(SERIAL_T) (free (SERIAL_T))
154 /* Set the process group saved in TTYSTATE to GROUP. This just modifies
155 the ttystate setting; need to call SERIAL_SET_TTY_STATE for this to
156 actually have any effect. If no job control, then don't do anything. */
157 #define SERIAL_SET_PROCESS_GROUP(SERIAL_T, TTYSTATE, GROUP) \
158 ((*((SERIAL_T)->ops->set_process_group)) (SERIAL_T, TTYSTATE, GROUP))
160 /* Do we have job control? Can be assumed to always be the same within
161 a given run of GDB. In ser-unix.c, ser-go32.c, etc. */
162 extern int job_control
;
164 /* Set the process group of the caller to its own pid, or do nothing if
165 we lack job control. */
166 extern int gdb_setpgid
PARAMS ((void));
168 #endif /* SERIAL_H */
This page took 0.032043 seconds and 4 git commands to generate.