xref: /freebsd/sys/sys/_termios.h (revision 29363fb446372cb3f10bc98664e9767c53fbb457)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1988, 1989, 1993, 1994
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef _SYS__TERMIOS_H_
33 #define	_SYS__TERMIOS_H_
34 
35 /*
36  * Special Control Characters
37  *
38  * Index into c_cc[] character array.
39  *
40  *	Name	     Subscript	Enabled by
41  */
42 #define	VEOF		0	/* ICANON */
43 #define	VEOL		1	/* ICANON */
44 #if __BSD_VISIBLE
45 #define	VEOL2		2	/* ICANON together with IEXTEN */
46 #endif
47 #define	VERASE		3	/* ICANON */
48 #if __BSD_VISIBLE
49 #define	VWERASE 	4	/* ICANON together with IEXTEN */
50 #endif
51 #define	VKILL		5	/* ICANON */
52 #if __BSD_VISIBLE
53 #define	VREPRINT 	6	/* ICANON together with IEXTEN */
54 #define	VERASE2 	7	/* ICANON */
55 #endif
56 /*			7	   ex-spare 1 */
57 #define	VINTR		8	/* ISIG */
58 #define	VQUIT		9	/* ISIG */
59 #define	VSUSP		10	/* ISIG */
60 #if __BSD_VISIBLE
61 #define	VDSUSP		11	/* ISIG together with IEXTEN */
62 #endif
63 #define	VSTART		12	/* IXON, IXOFF */
64 #define	VSTOP		13	/* IXON, IXOFF */
65 #if __BSD_VISIBLE
66 #define	VLNEXT		14	/* IEXTEN */
67 #define	VDISCARD	15	/* IEXTEN */
68 #endif
69 #define	VMIN		16	/* !ICANON */
70 #define	VTIME		17	/* !ICANON */
71 #if __BSD_VISIBLE
72 #define	VSTATUS		18	/* ICANON together with IEXTEN */
73 /*			19	   spare 2 */
74 #endif
75 #define	NCCS		20
76 
77 #define	_POSIX_VDISABLE	0xff
78 
79 /*
80  * Input flags - software input processing
81  */
82 #define	IGNBRK		0x00000001	/* ignore BREAK condition */
83 #define	BRKINT		0x00000002	/* map BREAK to SIGINTR */
84 #define	IGNPAR		0x00000004	/* ignore (discard) parity errors */
85 #define	PARMRK		0x00000008	/* mark parity and framing errors */
86 #define	INPCK		0x00000010	/* enable checking of parity errors */
87 #define	ISTRIP		0x00000020	/* strip 8th bit off chars */
88 #define	INLCR		0x00000040	/* map NL into CR */
89 #define	IGNCR		0x00000080	/* ignore CR */
90 #define	ICRNL		0x00000100	/* map CR to NL (ala CRMOD) */
91 #define	IXON		0x00000200	/* enable output flow control */
92 #define	IXOFF		0x00000400	/* enable input flow control */
93 #if __XSI_VISIBLE || __POSIX_VISIBLE >= 200809
94 #define	IXANY		0x00000800	/* any char will restart after stop */
95 #endif
96 #if __BSD_VISIBLE
97 #define	IMAXBEL		0x00002000	/* ring bell on input queue full */
98 #define IUTF8		0x00004000	/* assume input is utf-8 encoded */
99 #endif
100 
101 /*
102  * Output flags - software output processing
103  */
104 #define	OPOST		0x00000001	/* enable following output processing */
105 #if __XSI_VISIBLE
106 #define	ONLCR		0x00000002	/* map NL to CR-NL (ala CRMOD) */
107 #endif
108 #if __BSD_VISIBLE
109 #define	TABDLY		0x00000004	/* tab delay mask */
110 #define	    TAB0	    0x00000000	    /* no tab delay and expansion */
111 #define	    TAB3	    0x00000004	    /* expand tabs to spaces */
112 #define	ONOEOT		0x00000008	/* discard EOT's (^D) on output) */
113 #endif
114 #if __XSI_VISIBLE
115 #define	OCRNL		0x00000010	/* map CR to NL on output */
116 #define	ONOCR		0x00000020	/* no CR output at column 0 */
117 #define	ONLRET		0x00000040	/* NL performs CR function */
118 #endif
119 
120 /*
121  * Control flags - hardware control of terminal
122  */
123 #if __BSD_VISIBLE
124 #define	CIGNORE		0x00000001	/* ignore control flags */
125 #endif
126 #define	CSIZE		0x00000300	/* character size mask */
127 #define	    CS5		    0x00000000	    /* 5 bits (pseudo) */
128 #define	    CS6		    0x00000100	    /* 6 bits */
129 #define	    CS7		    0x00000200	    /* 7 bits */
130 #define	    CS8		    0x00000300	    /* 8 bits */
131 #define	CSTOPB		0x00000400	/* send 2 stop bits */
132 #define	CREAD		0x00000800	/* enable receiver */
133 #define	PARENB		0x00001000	/* parity enable */
134 #define	PARODD		0x00002000	/* odd parity, else even */
135 #define	HUPCL		0x00004000	/* hang up on last close */
136 #define	CLOCAL		0x00008000	/* ignore modem status lines */
137 #if __BSD_VISIBLE
138 #define	CCTS_OFLOW	0x00010000	/* CTS flow control of output */
139 #define	CRTSCTS		(CCTS_OFLOW | CRTS_IFLOW)
140 #define	CRTS_IFLOW	0x00020000	/* RTS flow control of input */
141 #define	CDTR_IFLOW	0x00040000	/* DTR flow control of input */
142 #define	CDSR_OFLOW	0x00080000	/* DSR flow control of output */
143 #define	CCAR_OFLOW	0x00100000	/* DCD flow control of output */
144 #define	CNO_RTSDTR	0x00200000	/* Do not assert RTS or DTR automatically */
145 #endif
146 
147 /*
148  * "Local" flags - dumping ground for other state
149  *
150  * Warning: some flags in this structure begin with
151  * the letter "I" and look like they belong in the
152  * input flag.
153  */
154 
155 #if __BSD_VISIBLE
156 #define	ECHOKE		0x00000001	/* visual erase for line kill */
157 #endif
158 #define	ECHOE		0x00000002	/* visually erase chars */
159 #define	ECHOK		0x00000004	/* echo NL after line kill */
160 #define	ECHO		0x00000008	/* enable echoing */
161 #define	ECHONL		0x00000010	/* echo NL even if ECHO is off */
162 #if __BSD_VISIBLE
163 #define	ECHOPRT		0x00000020	/* visual erase mode for hardcopy */
164 #define	ECHOCTL  	0x00000040	/* echo control chars as ^(Char) */
165 #endif
166 #define	ISIG		0x00000080	/* enable signals INTR, QUIT, [D]SUSP */
167 #define	ICANON		0x00000100	/* canonicalize input lines */
168 #if __BSD_VISIBLE
169 #define	ALTWERASE	0x00000200	/* use alternate WERASE algorithm */
170 #endif
171 #define	IEXTEN		0x00000400	/* enable DISCARD and LNEXT */
172 #define	EXTPROC         0x00000800      /* external processing */
173 #define	TOSTOP		0x00400000	/* stop background jobs from output */
174 #if __BSD_VISIBLE
175 #define	FLUSHO		0x00800000	/* output being flushed (state) */
176 #define	NOKERNINFO	0x02000000	/* no kernel output from VSTATUS */
177 #define	PENDIN		0x20000000	/* XXX retype pending input (state) */
178 #endif
179 #define	NOFLSH		0x80000000	/* don't flush after interrupt */
180 
181 /*
182  * Standard speeds
183  */
184 #define	B0	0
185 #define	B50	50
186 #define	B75	75
187 #define	B110	110
188 #define	B134	134
189 #define	B150	150
190 #define	B200	200
191 #define	B300	300
192 #define	B600	600
193 #define	B1200	1200
194 #define	B1800	1800
195 #define	B2400	2400
196 #define	B4800	4800
197 #define	B9600	9600
198 #define	B19200	19200
199 #define	B38400	38400
200 #if __BSD_VISIBLE
201 #define	B7200	7200
202 #define	B14400	14400
203 #define	B28800	28800
204 #define	B57600	57600
205 #define	B76800	76800
206 #define	B115200	115200
207 #define	B230400	230400
208 #define	B460800	460800
209 #define B500000 500000
210 #define	B921600	921600
211 #define B1000000	1000000U
212 #define B1500000	1500000U
213 #define B2000000	2000000U
214 #define B2500000	2500000U
215 #define B3000000	3000000U
216 #define B3500000	3500000U
217 #define B4000000	4000000U
218 #define	EXTA	19200
219 #define	EXTB	38400
220 #endif
221 
222 typedef unsigned int	tcflag_t;
223 typedef unsigned char	cc_t;
224 typedef unsigned int	speed_t;
225 
226 struct termios {
227 	tcflag_t	c_iflag;	/* input flags */
228 	tcflag_t	c_oflag;	/* output flags */
229 	tcflag_t	c_cflag;	/* control flags */
230 	tcflag_t	c_lflag;	/* local flags */
231 	cc_t		c_cc[NCCS];	/* control chars */
232 	speed_t		c_ispeed;	/* input speed */
233 	speed_t		c_ospeed;	/* output speed */
234 };
235 
236 #endif /* !_SYS__TERMIOS_H_ */
237