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