]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/termios.h
xnu-792.17.14.tar.gz
[apple/xnu.git] / bsd / sys / termios.h
CommitLineData
1c79356b 1/*
5d5c5d0d
A
2 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
3 *
8f6c56a5 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
8f6c56a5
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
8ad349bb 24 * limitations under the License.
8f6c56a5
A
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/* Copyright (c) 1997 Apple Computer, Inc. All Rights Reserved */
29/*
30 * Copyright (c) 1988, 1989, 1993, 1994
31 * The Regents of the University of California. All rights reserved.
32 *
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
35 * are met:
36 * 1. Redistributions of source code must retain the above copyright
37 * notice, this list of conditions and the following disclaimer.
38 * 2. Redistributions in binary form must reproduce the above copyright
39 * notice, this list of conditions and the following disclaimer in the
40 * documentation and/or other materials provided with the distribution.
41 * 3. All advertising materials mentioning features or use of this software
42 * must display the following acknowledgement:
43 * This product includes software developed by the University of
44 * California, Berkeley and its contributors.
45 * 4. Neither the name of the University nor the names of its contributors
46 * may be used to endorse or promote products derived from this software
47 * without specific prior written permission.
48 *
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * SUCH DAMAGE.
60 *
61 * @(#)termios.h 8.3 (Berkeley) 3/28/94
62 */
63
64#ifndef _SYS_TERMIOS_H_
65#define _SYS_TERMIOS_H_
66
91447636
A
67#include <sys/cdefs.h>
68
1c79356b
A
69/*
70 * Special Control Characters
71 *
72 * Index into c_cc[] character array.
73 *
74 * Name Subscript Enabled by
75 */
76#define VEOF 0 /* ICANON */
77#define VEOL 1 /* ICANON */
91447636 78#ifndef _POSIX_C_SOURCE
1c79356b
A
79#define VEOL2 2 /* ICANON together with IEXTEN */
80#endif
81#define VERASE 3 /* ICANON */
91447636 82#ifndef _POSIX_C_SOURCE
1c79356b
A
83#define VWERASE 4 /* ICANON together with IEXTEN */
84#endif
85#define VKILL 5 /* ICANON */
91447636 86#ifndef _POSIX_C_SOURCE
1c79356b
A
87#define VREPRINT 6 /* ICANON together with IEXTEN */
88#endif
89/* 7 spare 1 */
90#define VINTR 8 /* ISIG */
91#define VQUIT 9 /* ISIG */
92#define VSUSP 10 /* ISIG */
91447636 93#ifndef _POSIX_C_SOURCE
1c79356b
A
94#define VDSUSP 11 /* ISIG together with IEXTEN */
95#endif
96#define VSTART 12 /* IXON, IXOFF */
97#define VSTOP 13 /* IXON, IXOFF */
91447636 98#ifndef _POSIX_C_SOURCE
1c79356b
A
99#define VLNEXT 14 /* IEXTEN */
100#define VDISCARD 15 /* IEXTEN */
101#endif
102#define VMIN 16 /* !ICANON */
103#define VTIME 17 /* !ICANON */
91447636 104#ifndef _POSIX_C_SOURCE
1c79356b
A
105#define VSTATUS 18 /* ICANON together with IEXTEN */
106/* 19 spare 2 */
107#endif
108#define NCCS 20
109
110#ifndef _POSIX_VDISABLE
111#define _POSIX_VDISABLE 0xff
112#endif
113
91447636 114#ifndef _POSIX_C_SOURCE
1c79356b
A
115#define CCEQ(val, c) ((c) == (val) ? (val) != _POSIX_VDISABLE : 0)
116#endif
117
118/*
119 * Input flags - software input processing
120 */
121#define IGNBRK 0x00000001 /* ignore BREAK condition */
122#define BRKINT 0x00000002 /* map BREAK to SIGINTR */
123#define IGNPAR 0x00000004 /* ignore (discard) parity errors */
124#define PARMRK 0x00000008 /* mark parity and framing errors */
125#define INPCK 0x00000010 /* enable checking of parity errors */
126#define ISTRIP 0x00000020 /* strip 8th bit off chars */
127#define INLCR 0x00000040 /* map NL into CR */
128#define IGNCR 0x00000080 /* ignore CR */
129#define ICRNL 0x00000100 /* map CR to NL (ala CRMOD) */
130#define IXON 0x00000200 /* enable output flow control */
131#define IXOFF 0x00000400 /* enable input flow control */
1c79356b 132#define IXANY 0x00000800 /* any char will restart after stop */
91447636 133#ifndef _POSIX_C_SOURCE
1c79356b 134#define IMAXBEL 0x00002000 /* ring bell on input queue full */
91447636 135#endif /*_POSIX_C_SOURCE */
1c79356b
A
136
137/*
138 * Output flags - software output processing
139 */
140#define OPOST 0x00000001 /* enable following output processing */
1c79356b 141#define ONLCR 0x00000002 /* map NL to CR-NL (ala CRMOD) */
91447636 142#ifndef _POSIX_C_SOURCE
1c79356b
A
143#define OXTABS 0x00000004 /* expand tabs to spaces */
144#define ONOEOT 0x00000008 /* discard EOT's (^D) on output) */
91447636
A
145#endif /*_POSIX_C_SOURCE */
146/*
147 * The following block of features is unimplemented. Use of these flags in
148 * programs will currently result in unexpected behaviour.
149 *
150 * - Begin unimplemented features
151 */
152#define OCRNL 0x00000010 /* map CR to NL on output */
153#define ONOCR 0x00000020 /* no CR output at column 0 */
154#define ONLRET 0x00000040 /* NL performs CR function */
155#define OFILL 0x00000080 /* use fill characters for delay */
156#define NLDLY 0x00000300 /* \n delay */
157#define TABDLY 0x00000c00 /* horizontal tab delay */
158#define CRDLY 0x00003000 /* \r delay */
159#define FFDLY 0x00004000 /* form feed delay */
160#define BSDLY 0x00008000 /* \b delay */
161#define VTDLY 0x00010000 /* vertical tab delay */
162#define OFDEL 0x00020000 /* fill is DEL, else NUL */
163#if !defined(_SYS_IOCTL_COMPAT_H_) || defined(_POSIX_C_SOURCE)
164/*
165 * These manifest constants have the same names as those in the header
166 * <sys/ioctl_compat.h>, so you are not permitted to have both definitions
167 * in scope simultaneously in the same compilation unit. Nevertheless,
168 * they are required to be in scope when _POSIX_C_SOURCE is requested;
169 * this means that including the <sys/ioctl_compat.h> header before this
170 * one whien _POSIX_C_SOURCE is in scope will result in redefintions. We
171 * attempt to maintain these as the same values so as to avoid this being
172 * an outright error in most compilers.
173 */
174#define NL0 0x00000000
175#define NL1 0x00000100
176#define NL2 0x00000200
177#define NL3 0x00000300
178#define TAB0 0x00000000
179#define TAB1 0x00000400
180#define TAB2 0x00000800
181#define TAB3 0x00000c00
182#define CR0 0x00000000
183#define CR1 0x00001000
184#define CR2 0x00002000
185#define CR3 0x00003000
186#define FF0 0x00000000
187#define FF1 0x00004000
188#define BS0 0x00000000
189#define BS1 0x00008000
190#define VT0 0x00000000
191#define VT1 0x00010000
192#endif /* !_SYS_IOCTL_COMPAT_H_ */
193/*
194 * + End unimplemented features
195 */
1c79356b
A
196
197/*
198 * Control flags - hardware control of terminal
199 */
91447636 200#ifndef _POSIX_C_SOURCE
1c79356b
A
201#define CIGNORE 0x00000001 /* ignore control flags */
202#endif
203#define CSIZE 0x00000300 /* character size mask */
204#define CS5 0x00000000 /* 5 bits (pseudo) */
205#define CS6 0x00000100 /* 6 bits */
206#define CS7 0x00000200 /* 7 bits */
207#define CS8 0x00000300 /* 8 bits */
208#define CSTOPB 0x00000400 /* send 2 stop bits */
209#define CREAD 0x00000800 /* enable receiver */
210#define PARENB 0x00001000 /* parity enable */
211#define PARODD 0x00002000 /* odd parity, else even */
212#define HUPCL 0x00004000 /* hang up on last close */
213#define CLOCAL 0x00008000 /* ignore modem status lines */
91447636 214#ifndef _POSIX_C_SOURCE
1c79356b
A
215#define CCTS_OFLOW 0x00010000 /* CTS flow control of output */
216#define CRTSCTS (CCTS_OFLOW | CRTS_IFLOW)
217#define CRTS_IFLOW 0x00020000 /* RTS flow control of input */
218#define CDTR_IFLOW 0x00040000 /* DTR flow control of input */
219#define CDSR_OFLOW 0x00080000 /* DSR flow control of output */
220#define CCAR_OFLOW 0x00100000 /* DCD flow control of output */
221#define MDMBUF 0x00100000 /* old name for CCAR_OFLOW */
222#endif
223
224
225/*
226 * "Local" flags - dumping ground for other state
227 *
228 * Warning: some flags in this structure begin with
229 * the letter "I" and look like they belong in the
230 * input flag.
231 */
232
91447636 233#ifndef _POSIX_C_SOURCE
1c79356b 234#define ECHOKE 0x00000001 /* visual erase for line kill */
91447636 235#endif /*_POSIX_C_SOURCE */
1c79356b
A
236#define ECHOE 0x00000002 /* visually erase chars */
237#define ECHOK 0x00000004 /* echo NL after line kill */
238#define ECHO 0x00000008 /* enable echoing */
239#define ECHONL 0x00000010 /* echo NL even if ECHO is off */
91447636 240#ifndef _POSIX_C_SOURCE
1c79356b
A
241#define ECHOPRT 0x00000020 /* visual erase mode for hardcopy */
242#define ECHOCTL 0x00000040 /* echo control chars as ^(Char) */
91447636 243#endif /*_POSIX_C_SOURCE */
1c79356b
A
244#define ISIG 0x00000080 /* enable signals INTR, QUIT, [D]SUSP */
245#define ICANON 0x00000100 /* canonicalize input lines */
91447636 246#ifndef _POSIX_C_SOURCE
1c79356b 247#define ALTWERASE 0x00000200 /* use alternate WERASE algorithm */
91447636 248#endif /*_POSIX_C_SOURCE */
1c79356b
A
249#define IEXTEN 0x00000400 /* enable DISCARD and LNEXT */
250#define EXTPROC 0x00000800 /* external processing */
251#define TOSTOP 0x00400000 /* stop background jobs from output */
91447636 252#ifndef _POSIX_C_SOURCE
1c79356b
A
253#define FLUSHO 0x00800000 /* output being flushed (state) */
254#define NOKERNINFO 0x02000000 /* no kernel output from VSTATUS */
255#define PENDIN 0x20000000 /* XXX retype pending input (state) */
91447636 256#endif /*_POSIX_C_SOURCE */
1c79356b
A
257#define NOFLSH 0x80000000 /* don't flush after interrupt */
258
259typedef unsigned long tcflag_t;
260typedef unsigned char cc_t;
261typedef long speed_t; /* XXX should be unsigned long */
262
263struct termios {
264 tcflag_t c_iflag; /* input flags */
265 tcflag_t c_oflag; /* output flags */
266 tcflag_t c_cflag; /* control flags */
267 tcflag_t c_lflag; /* local flags */
268 cc_t c_cc[NCCS]; /* control chars */
269 speed_t c_ispeed; /* input speed */
270 speed_t c_ospeed; /* output speed */
271};
272
91447636
A
273#ifdef KERNEL
274typedef unsigned long long user_tcflag_t;
275typedef unsigned long long user_speed_t;
276
277/*
278 * LP64 version of struct termios. tcflag_t and speed_t are long and must
279 * grow when we're dealing with a 64-bit process.
280 * WARNING - keep in sync with struct termios
281 */
282
8f6c56a5
A
283#if __DARWIN_ALIGN_NATURAL
284#pragma options align=natural
285#endif
286
91447636
A
287struct user_termios {
288 user_tcflag_t c_iflag; /* input flags */
289 user_tcflag_t c_oflag; /* output flags */
290 user_tcflag_t c_cflag; /* control flags */
291 user_tcflag_t c_lflag; /* local flags */
292 cc_t c_cc[NCCS]; /* control chars */
8f6c56a5 293 user_speed_t c_ispeed; /* input speed */
91447636
A
294 user_speed_t c_ospeed; /* output speed */
295};
296
8f6c56a5
A
297#if __DARWIN_ALIGN_NATURAL
298#pragma options align=reset
299#endif
300
91447636
A
301#endif /* KERNEL */
302
1c79356b
A
303/*
304 * Commands passed to tcsetattr() for setting the termios structure.
305 */
306#define TCSANOW 0 /* make change immediate */
307#define TCSADRAIN 1 /* drain output, then change */
308#define TCSAFLUSH 2 /* drain output, flush input */
91447636 309#ifndef _POSIX_C_SOURCE
1c79356b
A
310#define TCSASOFT 0x10 /* flag - don't alter h.w. state */
311#endif
312
313/*
314 * Standard speeds
315 */
316#define B0 0
317#define B50 50
318#define B75 75
319#define B110 110
320#define B134 134
321#define B150 150
322#define B200 200
323#define B300 300
324#define B600 600
325#define B1200 1200
326#define B1800 1800
327#define B2400 2400
328#define B4800 4800
329#define B9600 9600
330#define B19200 19200
331#define B38400 38400
91447636 332#ifndef _POSIX_C_SOURCE
1c79356b
A
333#define B7200 7200
334#define B14400 14400
335#define B28800 28800
336#define B57600 57600
337#define B76800 76800
338#define B115200 115200
339#define B230400 230400
340#define EXTA 19200
341#define EXTB 38400
91447636 342#endif /* !_POSIX_C_SOURCE */
1c79356b
A
343
344#ifndef KERNEL
345
346#define TCIFLUSH 1
347#define TCOFLUSH 2
348#define TCIOFLUSH 3
349#define TCOOFF 1
350#define TCOON 2
351#define TCIOFF 3
352#define TCION 4
353
354#include <sys/cdefs.h>
355
356__BEGIN_DECLS
91447636
A
357speed_t cfgetispeed(const struct termios *);
358speed_t cfgetospeed(const struct termios *);
359int cfsetispeed(struct termios *, speed_t);
360int cfsetospeed(struct termios *, speed_t);
361int tcgetattr(int, struct termios *);
362int tcsetattr(int, int, const struct termios *);
363int tcdrain(int);
364int tcflow(int, int);
365int tcflush(int, int);
366int tcsendbreak(int, int);
1c79356b 367
91447636
A
368#ifndef _POSIX_C_SOURCE
369void cfmakeraw(struct termios *);
370int cfsetspeed(struct termios *, speed_t);
371#endif /* !_POSIX_C_SOURCE */
1c79356b
A
372__END_DECLS
373
374#endif /* !KERNEL */
375
91447636 376#ifndef _POSIX_C_SOURCE
1c79356b
A
377
378/*
379 * Include tty ioctl's that aren't just for backwards compatibility
380 * with the old tty driver. These ioctl definitions were previously
381 * in <sys/ioctl.h>.
382 */
383#include <sys/ttycom.h>
384#endif
385
386/*
387 * END OF PROTECTED INCLUDE.
388 */
389#endif /* !_SYS_TERMIOS_H_ */
390
91447636 391#ifndef _POSIX_C_SOURCE
1c79356b
A
392#include <sys/ttydefaults.h>
393#endif