termios.h revision 182817
1/*-
2 * Copyright (c) 1988, 1989, 1993, 1994
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 *    may be used to endorse or promote products derived from this software
15 *    without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 *	@(#)termios.h	8.3 (Berkeley) 3/28/94
30 * $FreeBSD: head/sys/sys/termios.h 182817 2008-09-06 15:41:58Z ed $
31 */
32
33#ifndef _SYS_TERMIOS_H_
34#define	_SYS_TERMIOS_H_
35
36#include <sys/_types.h>
37#ifndef _PID_T_DECLARED
38typedef	__pid_t		pid_t;
39#define	_PID_T_DECLARED
40#endif
41
42/*
43 * Special Control Characters
44 *
45 * Index into c_cc[] character array.
46 *
47 *	Name	     Subscript	Enabled by
48 */
49#define	VEOF		0	/* ICANON */
50#define	VEOL		1	/* ICANON */
51#ifndef _POSIX_SOURCE
52#define	VEOL2		2	/* ICANON together with IEXTEN */
53#endif
54#define	VERASE		3	/* ICANON */
55#ifndef _POSIX_SOURCE
56#define	VWERASE 	4	/* ICANON together with IEXTEN */
57#endif
58#define	VKILL		5	/* ICANON */
59#ifndef _POSIX_SOURCE
60#define	VREPRINT 	6	/* ICANON together with IEXTEN */
61#define	VERASE2 	7	/* ICANON */
62#endif
63/*			7	   ex-spare 1 */
64#define	VINTR		8	/* ISIG */
65#define	VQUIT		9	/* ISIG */
66#define	VSUSP		10	/* ISIG */
67#ifndef _POSIX_SOURCE
68#define	VDSUSP		11	/* ISIG together with IEXTEN */
69#endif
70#define	VSTART		12	/* IXON, IXOFF */
71#define	VSTOP		13	/* IXON, IXOFF */
72#ifndef _POSIX_SOURCE
73#define	VLNEXT		14	/* IEXTEN */
74#define	VDISCARD	15	/* IEXTEN */
75#endif
76#define	VMIN		16	/* !ICANON */
77#define	VTIME		17	/* !ICANON */
78#ifndef _POSIX_SOURCE
79#define	VSTATUS		18	/* ICANON together with IEXTEN */
80/*			19	   spare 2 */
81#endif
82#define	NCCS		20
83
84#define	_POSIX_VDISABLE	0xff
85
86/*
87 * Input flags - software input processing
88 */
89#define	IGNBRK		0x00000001	/* ignore BREAK condition */
90#define	BRKINT		0x00000002	/* map BREAK to SIGINTR */
91#define	IGNPAR		0x00000004	/* ignore (discard) parity errors */
92#define	PARMRK		0x00000008	/* mark parity and framing errors */
93#define	INPCK		0x00000010	/* enable checking of parity errors */
94#define	ISTRIP		0x00000020	/* strip 8th bit off chars */
95#define	INLCR		0x00000040	/* map NL into CR */
96#define	IGNCR		0x00000080	/* ignore CR */
97#define	ICRNL		0x00000100	/* map CR to NL (ala CRMOD) */
98#define	IXON		0x00000200	/* enable output flow control */
99#define	IXOFF		0x00000400	/* enable input flow control */
100#ifndef _POSIX_SOURCE
101#define	IXANY		0x00000800	/* any char will restart after stop */
102#define	IMAXBEL		0x00002000	/* ring bell on input queue full */
103#endif  /*_POSIX_SOURCE */
104
105/*
106 * Output flags - software output processing
107 */
108#define	OPOST		0x00000001	/* enable following output processing */
109#ifndef _POSIX_SOURCE
110#define	ONLCR		0x00000002	/* map NL to CR-NL (ala CRMOD) */
111#define	TABDLY		0x00000004	/* tab delay mask */
112#define	    TAB0	    0x00000000	    /* no tab delay and expansion */
113#define	    TAB3	    0x00000004	    /* expand tabs to spaces */
114#ifndef _KERNEL
115#define	OXTABS		TAB3
116#endif /* !_KERNEL */
117#define	ONOEOT		0x00000008	/* discard EOT's (^D) on output) */
118#define	OCRNL		0x00000010	/* map CR to NL on output */
119#define	ONOCR		0x00000020	/* no CR output at column 0 */
120#define	ONLRET		0x00000040	/* NL performs CR function */
121#endif  /*_POSIX_SOURCE */
122
123/*
124 * Control flags - hardware control of terminal
125 */
126#ifndef _POSIX_SOURCE
127#define	CIGNORE		0x00000001	/* ignore control flags */
128#endif
129#define	CSIZE		0x00000300	/* character size mask */
130#define	    CS5		    0x00000000	    /* 5 bits (pseudo) */
131#define	    CS6		    0x00000100	    /* 6 bits */
132#define	    CS7		    0x00000200	    /* 7 bits */
133#define	    CS8		    0x00000300	    /* 8 bits */
134#define	CSTOPB		0x00000400	/* send 2 stop bits */
135#define	CREAD		0x00000800	/* enable receiver */
136#define	PARENB		0x00001000	/* parity enable */
137#define	PARODD		0x00002000	/* odd parity, else even */
138#define	HUPCL		0x00004000	/* hang up on last close */
139#define	CLOCAL		0x00008000	/* ignore modem status lines */
140#ifndef _POSIX_SOURCE
141#define	CCTS_OFLOW	0x00010000	/* CTS flow control of output */
142#define	CRTSCTS		(CCTS_OFLOW | CRTS_IFLOW)
143#define	CRTS_IFLOW	0x00020000	/* RTS flow control of input */
144#define	CDTR_IFLOW	0x00040000	/* DTR flow control of input */
145#define	CDSR_OFLOW	0x00080000	/* DSR flow control of output */
146#define	CCAR_OFLOW	0x00100000	/* DCD flow control of output */
147#ifndef _KERNEL
148#define	MDMBUF		CCAR_OFLOW
149#endif /* !_KERNEL */
150#endif
151
152
153/*
154 * "Local" flags - dumping ground for other state
155 *
156 * Warning: some flags in this structure begin with
157 * the letter "I" and look like they belong in the
158 * input flag.
159 */
160
161#ifndef _POSIX_SOURCE
162#define	ECHOKE		0x00000001	/* visual erase for line kill */
163#endif  /*_POSIX_SOURCE */
164#define	ECHOE		0x00000002	/* visually erase chars */
165#define	ECHOK		0x00000004	/* echo NL after line kill */
166#define	ECHO		0x00000008	/* enable echoing */
167#define	ECHONL		0x00000010	/* echo NL even if ECHO is off */
168#ifndef _POSIX_SOURCE
169#define	ECHOPRT		0x00000020	/* visual erase mode for hardcopy */
170#define	ECHOCTL  	0x00000040	/* echo control chars as ^(Char) */
171#endif  /*_POSIX_SOURCE */
172#define	ISIG		0x00000080	/* enable signals INTR, QUIT, [D]SUSP */
173#define	ICANON		0x00000100	/* canonicalize input lines */
174#ifndef _POSIX_SOURCE
175#define	ALTWERASE	0x00000200	/* use alternate WERASE algorithm */
176#endif  /*_POSIX_SOURCE */
177#define	IEXTEN		0x00000400	/* enable DISCARD and LNEXT */
178#define	EXTPROC         0x00000800      /* external processing */
179#define	TOSTOP		0x00400000	/* stop background jobs from output */
180#ifndef _POSIX_SOURCE
181#define	FLUSHO		0x00800000	/* output being flushed (state) */
182#define	NOKERNINFO	0x02000000	/* no kernel output from VSTATUS */
183#define	PENDIN		0x20000000	/* XXX retype pending input (state) */
184#endif  /*_POSIX_SOURCE */
185#define	NOFLSH		0x80000000	/* don't flush after interrupt */
186
187typedef unsigned int	tcflag_t;
188typedef unsigned char	cc_t;
189typedef unsigned int	speed_t;
190
191struct termios {
192	tcflag_t	c_iflag;	/* input flags */
193	tcflag_t	c_oflag;	/* output flags */
194	tcflag_t	c_cflag;	/* control flags */
195	tcflag_t	c_lflag;	/* local flags */
196	cc_t		c_cc[NCCS];	/* control chars */
197	speed_t		c_ispeed;	/* input speed */
198	speed_t		c_ospeed;	/* output speed */
199};
200
201/*
202 * Standard speeds
203 */
204#define	B0	0
205#define	B50	50
206#define	B75	75
207#define	B110	110
208#define	B134	134
209#define	B150	150
210#define	B200	200
211#define	B300	300
212#define	B600	600
213#define	B1200	1200
214#define	B1800	1800
215#define	B2400	2400
216#define	B4800	4800
217#define	B9600	9600
218#define	B19200	19200
219#define	B38400	38400
220#ifndef _POSIX_SOURCE
221#define	B7200	7200
222#define	B14400	14400
223#define	B28800	28800
224#define	B57600	57600
225#define	B76800	76800
226#define	B115200	115200
227#define	B230400	230400
228#define	B460800	460800
229#define	B921600	921600
230#define	EXTA	19200
231#define	EXTB	38400
232#endif  /* !_POSIX_SOURCE */
233
234#ifndef _KERNEL
235
236#ifndef _POSIX_SOURCE
237#define	CCEQ(val, c)	((c) != _POSIX_VDISABLE && (c) == (val))
238#endif
239
240/*
241 * Commands passed to tcsetattr() for setting the termios structure.
242 */
243#define	TCSANOW		0		/* make change immediate */
244#define	TCSADRAIN	1		/* drain output, then change */
245#define	TCSAFLUSH	2		/* drain output, flush input */
246#ifndef _POSIX_SOURCE
247#define	TCSASOFT	0x10		/* flag - don't alter h.w. state */
248#endif
249
250#define	TCIFLUSH	1
251#define	TCOFLUSH	2
252#define	TCIOFLUSH	3
253#define	TCOOFF		1
254#define	TCOON		2
255#define	TCIOFF		3
256#define	TCION		4
257
258#include <sys/cdefs.h>
259
260__BEGIN_DECLS
261speed_t	cfgetispeed(const struct termios *);
262speed_t	cfgetospeed(const struct termios *);
263int	cfsetispeed(struct termios *, speed_t);
264int	cfsetospeed(struct termios *, speed_t);
265int	tcgetattr(int, struct termios *);
266int	tcsetattr(int, int, const struct termios *);
267int	tcdrain(int);
268int	tcflow(int, int);
269int	tcflush(int, int);
270int	tcsendbreak(int, int);
271
272#if __POSIX_VISIBLE >= 200112 || __BSD_VISIBLE
273pid_t	tcgetsid(int);
274#endif
275
276#ifndef _POSIX_SOURCE
277void	cfmakeraw(struct termios *);
278int	cfsetspeed(struct termios *, speed_t);
279#endif /* !_POSIX_SOURCE */
280__END_DECLS
281
282#endif /* !_KERNEL */
283
284#ifndef _POSIX_SOURCE
285
286/*
287 * Include tty ioctl's that aren't just for backwards compatibility
288 * with the old tty driver.  These ioctl definitions were previously
289 * in <sys/ioctl.h>.
290 */
291#include <sys/ttycom.h>
292#endif
293
294/*
295 * END OF PROTECTED INCLUDE.
296 */
297#endif /* !_SYS_TERMIOS_H_ */
298
299#ifndef _POSIX_SOURCE
300#include <sys/ttydefaults.h>
301#endif
302