termios.h revision 180561
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 180561 2008-07-16 12:36:39Z 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#ifndef _POSIX_SOURCE
87#define	CCEQ(val, c)	((c) == (val) ? (val) != _POSIX_VDISABLE : 0)
88#endif
89
90/*
91 * Input flags - software input processing
92 */
93#define	IGNBRK		0x00000001	/* ignore BREAK condition */
94#define	BRKINT		0x00000002	/* map BREAK to SIGINTR */
95#define	IGNPAR		0x00000004	/* ignore (discard) parity errors */
96#define	PARMRK		0x00000008	/* mark parity and framing errors */
97#define	INPCK		0x00000010	/* enable checking of parity errors */
98#define	ISTRIP		0x00000020	/* strip 8th bit off chars */
99#define	INLCR		0x00000040	/* map NL into CR */
100#define	IGNCR		0x00000080	/* ignore CR */
101#define	ICRNL		0x00000100	/* map CR to NL (ala CRMOD) */
102#define	IXON		0x00000200	/* enable output flow control */
103#define	IXOFF		0x00000400	/* enable input flow control */
104#ifndef _POSIX_SOURCE
105#define	IXANY		0x00000800	/* any char will restart after stop */
106#define IMAXBEL		0x00002000	/* ring bell on input queue full */
107#endif  /*_POSIX_SOURCE */
108
109/*
110 * Output flags - software output processing
111 */
112#define	OPOST		0x00000001	/* enable following output processing */
113#ifndef _POSIX_SOURCE
114#define ONLCR		0x00000002	/* map NL to CR-NL (ala CRMOD) */
115#define OXTABS		0x00000004	/* expand tabs to spaces */
116#define ONOEOT		0x00000008	/* discard EOT's (^D) on output) */
117#define OCRNL		0x00000010	/* map CR to NL on output */
118#define ONOCR		0x00000020	/* no CR output at column 0 */
119#define ONLRET		0x00000040	/* NL performs CR function */
120#endif  /*_POSIX_SOURCE */
121
122/*
123 * Control flags - hardware control of terminal
124 */
125#ifndef _POSIX_SOURCE
126#define	CIGNORE		0x00000001	/* ignore control flags */
127#endif
128#define CSIZE		0x00000300	/* character size mask */
129#define     CS5		    0x00000000	    /* 5 bits (pseudo) */
130#define     CS6		    0x00000100	    /* 6 bits */
131#define     CS7		    0x00000200	    /* 7 bits */
132#define     CS8		    0x00000300	    /* 8 bits */
133#define CSTOPB		0x00000400	/* send 2 stop bits */
134#define CREAD		0x00000800	/* enable receiver */
135#define PARENB		0x00001000	/* parity enable */
136#define PARODD		0x00002000	/* odd parity, else even */
137#define HUPCL		0x00004000	/* hang up on last close */
138#define CLOCAL		0x00008000	/* ignore modem status lines */
139#ifndef _POSIX_SOURCE
140#define CCTS_OFLOW	0x00010000	/* CTS flow control of output */
141#define CRTSCTS		(CCTS_OFLOW | CRTS_IFLOW)
142#define CRTS_IFLOW	0x00020000	/* RTS flow control of input */
143#define	CDTR_IFLOW	0x00040000	/* DTR flow control of input */
144#define CDSR_OFLOW	0x00080000	/* DSR flow control of output */
145#define	CCAR_OFLOW	0x00100000	/* DCD flow control of output */
146#define	MDMBUF		0x00100000	/* old name for CCAR_OFLOW */
147#endif
148
149
150/*
151 * "Local" flags - dumping ground for other state
152 *
153 * Warning: some flags in this structure begin with
154 * the letter "I" and look like they belong in the
155 * input flag.
156 */
157
158#ifndef _POSIX_SOURCE
159#define	ECHOKE		0x00000001	/* visual erase for line kill */
160#endif  /*_POSIX_SOURCE */
161#define	ECHOE		0x00000002	/* visually erase chars */
162#define	ECHOK		0x00000004	/* echo NL after line kill */
163#define ECHO		0x00000008	/* enable echoing */
164#define	ECHONL		0x00000010	/* echo NL even if ECHO is off */
165#ifndef _POSIX_SOURCE
166#define	ECHOPRT		0x00000020	/* visual erase mode for hardcopy */
167#define ECHOCTL  	0x00000040	/* echo control chars as ^(Char) */
168#endif  /*_POSIX_SOURCE */
169#define	ISIG		0x00000080	/* enable signals INTR, QUIT, [D]SUSP */
170#define	ICANON		0x00000100	/* canonicalize input lines */
171#ifndef _POSIX_SOURCE
172#define ALTWERASE	0x00000200	/* use alternate WERASE algorithm */
173#endif  /*_POSIX_SOURCE */
174#define	IEXTEN		0x00000400	/* enable DISCARD and LNEXT */
175#define EXTPROC         0x00000800      /* external processing */
176#define TOSTOP		0x00400000	/* stop background jobs from output */
177#ifndef _POSIX_SOURCE
178#define FLUSHO		0x00800000	/* output being flushed (state) */
179#define	NOKERNINFO	0x02000000	/* no kernel output from VSTATUS */
180#define PENDIN		0x20000000	/* XXX retype pending input (state) */
181#endif  /*_POSIX_SOURCE */
182#define	NOFLSH		0x80000000	/* don't flush after interrupt */
183
184typedef unsigned int	tcflag_t;
185typedef unsigned char	cc_t;
186typedef unsigned int	speed_t;
187
188struct termios {
189	tcflag_t	c_iflag;	/* input flags */
190	tcflag_t	c_oflag;	/* output flags */
191	tcflag_t	c_cflag;	/* control flags */
192	tcflag_t	c_lflag;	/* local flags */
193	cc_t		c_cc[NCCS];	/* control chars */
194	speed_t		c_ispeed;	/* input speed */
195	speed_t		c_ospeed;	/* output speed */
196};
197
198/*
199 * Standard speeds
200 */
201#define B0	0
202#define B50	50
203#define B75	75
204#define B110	110
205#define B134	134
206#define B150	150
207#define B200	200
208#define B300	300
209#define B600	600
210#define B1200	1200
211#define	B1800	1800
212#define B2400	2400
213#define B4800	4800
214#define B9600	9600
215#define B19200	19200
216#define B38400	38400
217#ifndef _POSIX_SOURCE
218#define B7200	7200
219#define B14400	14400
220#define B28800	28800
221#define B57600	57600
222#define B76800	76800
223#define B115200	115200
224#define B230400	230400
225#define B460800	460800
226#define B921600	921600
227#define EXTA	19200
228#define EXTB	38400
229#endif  /* !_POSIX_SOURCE */
230
231#ifndef _KERNEL
232
233/*
234 * Commands passed to tcsetattr() for setting the termios structure.
235 */
236#define	TCSANOW		0		/* make change immediate */
237#define	TCSADRAIN	1		/* drain output, then change */
238#define	TCSAFLUSH	2		/* drain output, flush input */
239#ifndef _POSIX_SOURCE
240#define TCSASOFT	0x10		/* flag - don't alter h.w. state */
241#endif
242
243#define	TCIFLUSH	1
244#define	TCOFLUSH	2
245#define TCIOFLUSH	3
246#define	TCOOFF		1
247#define	TCOON		2
248#define TCIOFF		3
249#define TCION		4
250
251#include <sys/cdefs.h>
252
253__BEGIN_DECLS
254speed_t	cfgetispeed(const struct termios *);
255speed_t	cfgetospeed(const struct termios *);
256int	cfsetispeed(struct termios *, speed_t);
257int	cfsetospeed(struct termios *, speed_t);
258int	tcgetattr(int, struct termios *);
259int	tcsetattr(int, int, const struct termios *);
260int	tcdrain(int);
261int	tcflow(int, int);
262int	tcflush(int, int);
263int	tcsendbreak(int, int);
264
265#if __POSIX_VISIBLE >= 200112 || __BSD_VISIBLE
266pid_t	tcgetsid(int);
267#endif
268
269#ifndef _POSIX_SOURCE
270void	cfmakeraw(struct termios *);
271int	cfsetspeed(struct termios *, speed_t);
272#endif /* !_POSIX_SOURCE */
273__END_DECLS
274
275#endif /* !_KERNEL */
276
277#ifndef _POSIX_SOURCE
278
279/*
280 * Include tty ioctl's that aren't just for backwards compatibility
281 * with the old tty driver.  These ioctl definitions were previously
282 * in <sys/ioctl.h>.
283 */
284#include <sys/ttycom.h>
285#endif
286
287/*
288 * END OF PROTECTED INCLUDE.
289 */
290#endif /* !_SYS_TERMIOS_H_ */
291
292#ifndef _POSIX_SOURCE
293#include <sys/ttydefaults.h>
294#endif
295