bsd/sys/termios.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   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.
  11  *
  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
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  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.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  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
  61 #include <sys/cdefs.h>
  62
  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 */
  72 #ifndef _POSIX_C_SOURCE
  73 #define VEOL2           2       /* ICANON together with IEXTEN */
  74 #endif
  75 #define VERASE          3       /* ICANON */
  76 #ifndef _POSIX_C_SOURCE
  77 #define VWERASE         4       /* ICANON together with IEXTEN */
  78 #endif
  79 #define VKILL           5       /* ICANON */
  80 #ifndef _POSIX_C_SOURCE
  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 */
  87 #ifndef _POSIX_C_SOURCE
  88 #define VDSUSP          11      /* ISIG together with IEXTEN */
  89 #endif
  90 #define VSTART          12      /* IXON, IXOFF */
  91 #define VSTOP           13      /* IXON, IXOFF */
  92 #ifndef _POSIX_C_SOURCE
  93 #define VLNEXT          14      /* IEXTEN */
  94 #define VDISCARD        15      /* IEXTEN */
  95 #endif
  96 #define VMIN            16      /* !ICANON */
  97 #define VTIME           17      /* !ICANON */
  98 #ifndef _POSIX_C_SOURCE
  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
 108 #ifndef _POSIX_C_SOURCE
 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 */
 126 #define IXANY           0x00000800      /* any char will restart after stop */
 127 #ifndef _POSIX_C_SOURCE
 128 #define IMAXBEL         0x00002000      /* ring bell on input queue full */
 129 #endif  /*_POSIX_C_SOURCE */
 130
 131 /*
 132  * Output flags - software output processing
 133  */
 134 #define OPOST           0x00000001      /* enable following output processing */
 135 #define ONLCR           0x00000002      /* map NL to CR-NL (ala CRMOD) */
 136 #ifndef _POSIX_C_SOURCE
 137 #define OXTABS          0x00000004      /* expand tabs to spaces */
 138 #define ONOEOT          0x00000008      /* discard EOT's (^D) on output) */
 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  */
 190
 191 /*
 192  * Control flags - hardware control of terminal
 193  */
 194 #ifndef _POSIX_C_SOURCE
 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 */
 208 #ifndef _POSIX_C_SOURCE
 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
 227 #ifndef _POSIX_C_SOURCE
 228 #define ECHOKE          0x00000001      /* visual erase for line kill */
 229 #endif  /*_POSIX_C_SOURCE */
 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 */
 234 #ifndef _POSIX_C_SOURCE
 235 #define ECHOPRT         0x00000020      /* visual erase mode for hardcopy */
 236 #define ECHOCTL         0x00000040      /* echo control chars as ^(Char) */
 237 #endif  /*_POSIX_C_SOURCE */
 238 #define ISIG            0x00000080      /* enable signals INTR, QUIT, [D]SUSP */
 239 #define ICANON          0x00000100      /* canonicalize input lines */
 240 #ifndef _POSIX_C_SOURCE
 241 #define ALTWERASE       0x00000200      /* use alternate WERASE algorithm */
 242 #endif  /*_POSIX_C_SOURCE */
 243 #define IEXTEN          0x00000400      /* enable DISCARD and LNEXT */
 244 #define EXTPROC         0x00000800      /* external processing */
 245 #define TOSTOP          0x00400000      /* stop background jobs from output */
 246 #ifndef _POSIX_C_SOURCE
 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) */
 250 #endif  /*_POSIX_C_SOURCE */
 251 #define NOFLSH          0x80000000      /* don't flush after interrupt */
 252
 253 typedef unsigned long   tcflag_t;
 254 typedef unsigned char   cc_t;
 255 typedef long            speed_t;        /* XXX should be unsigned long */
 256
 257 struct 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
 267 #ifdef KERNEL
 268 typedef unsigned long long      user_tcflag_t;
 269 typedef 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
 277 struct user_termios {
 278         user_tcflag_t   c_iflag;        /* input flags */
 279         user_tcflag_t   c_oflag;        /* output flags */
 280         user_tcflag_t   c_cflag;        /* control flags */
 281         user_tcflag_t   c_lflag;        /* local flags */
 282         cc_t            c_cc[NCCS];     /* control chars */
 283         user_speed_t    c_ispeed __attribute((aligned(8)));     /* input speed */
 284         user_speed_t    c_ospeed;       /* output speed */
 285 };
 286
 287 #endif  /* KERNEL */
 288
 289 /*
 290  * Commands passed to tcsetattr() for setting the termios structure.
 291  */
 292 #define TCSANOW         0               /* make change immediate */
 293 #define TCSADRAIN       1               /* drain output, then change */
 294 #define TCSAFLUSH       2               /* drain output, flush input */
 295 #ifndef _POSIX_C_SOURCE
 296 #define TCSASOFT        0x10            /* flag - don't alter h.w. state */
 297 #endif
 298
 299 /*
 300  * Standard speeds
 301  */
 302 #define B0      0
 303 #define B50     50
 304 #define B75     75
 305 #define B110    110
 306 #define B134    134
 307 #define B150    150
 308 #define B200    200
 309 #define B300    300
 310 #define B600    600
 311 #define B1200   1200
 312 #define B1800   1800
 313 #define B2400   2400
 314 #define B4800   4800
 315 #define B9600   9600
 316 #define B19200  19200
 317 #define B38400  38400
 318 #ifndef _POSIX_C_SOURCE
 319 #define B7200   7200
 320 #define B14400  14400
 321 #define B28800  28800
 322 #define B57600  57600
 323 #define B76800  76800
 324 #define B115200 115200
 325 #define B230400 230400
 326 #define EXTA    19200
 327 #define EXTB    38400
 328 #endif  /* !_POSIX_C_SOURCE */
 329
 330 #ifndef KERNEL
 331
 332 #define TCIFLUSH        1
 333 #define TCOFLUSH        2
 334 #define TCIOFLUSH       3
 335 #define TCOOFF          1
 336 #define TCOON           2
 337 #define TCIOFF          3
 338 #define TCION           4
 339
 340 #include <sys/cdefs.h>
 341
 342 __BEGIN_DECLS
 343 speed_t cfgetispeed(const struct termios *);
 344 speed_t cfgetospeed(const struct termios *);
 345 int     cfsetispeed(struct termios *, speed_t);
 346 int     cfsetospeed(struct termios *, speed_t);
 347 int     tcgetattr(int, struct termios *);
 348 int     tcsetattr(int, int, const struct termios *);
 349 int     tcdrain(int);
 350 int     tcflow(int, int);
 351 int     tcflush(int, int);
 352 int     tcsendbreak(int, int);
 353
 354 #ifndef _POSIX_C_SOURCE
 355 void    cfmakeraw(struct termios *);
 356 int     cfsetspeed(struct termios *, speed_t);
 357 #endif /* !_POSIX_C_SOURCE */
 358 __END_DECLS
 359
 360 #endif /* !KERNEL */
 361
 362 #ifndef _POSIX_C_SOURCE
 363
 364 /*
 365  * Include tty ioctl's that aren't just for backwards compatibility
 366  * with the old tty driver.  These ioctl definitions were previously
 367  * in <sys/ioctl.h>.
 368  */
 369 #include <sys/ttycom.h>
 370 #endif
 371
 372 /*
 373  * END OF PROTECTED INCLUDE.
 374  */
 375 #endif /* !_SYS_TERMIOS_H_ */
 376
 377 #ifndef _POSIX_C_SOURCE
 378 #include <sys/ttydefaults.h>
 379 #endif