bsd/sys/termios.h

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