sys/sys/termios.h

   1 /*
   2  * Copyright (c) 1988, 1989, 1993, 1994
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)termios.h   8.3 (Berkeley) 3/28/94
  34  * $FreeBSD$
  35  */
  36
  37 #ifndef _SYS_TERMIOS_H_
  38 #define _SYS_TERMIOS_H_
  39
  40 /*
  41  * Special Control Characters
  42  *
  43  * Index into c_cc[] character array.
  44  *
  45  *      Name         Subscript  Enabled by
  46  */
  47 #define VEOF            0       /* ICANON */
  48 #define VEOL            1       /* ICANON */
  49 #ifndef _POSIX_SOURCE
  50 #define VEOL2           2       /* ICANON together with IEXTEN */
  51 #endif
  52 #define VERASE          3       /* ICANON */
  53 #ifndef _POSIX_SOURCE
  54 #define VWERASE         4       /* ICANON together with IEXTEN */
  55 #endif
  56 #define VKILL           5       /* ICANON */
  57 #ifndef _POSIX_SOURCE
  58 #define VREPRINT        6       /* ICANON together with IEXTEN */
  59 #endif
  60 /*                      7          spare 1 */
  61 #define VINTR           8       /* ISIG */
  62 #define VQUIT           9       /* ISIG */
  63 #define VSUSP           10      /* ISIG */
  64 #ifndef _POSIX_SOURCE
  65 #define VDSUSP          11      /* ISIG together with IEXTEN */
  66 #endif
  67 #define VSTART          12      /* IXON, IXOFF */
  68 #define VSTOP           13      /* IXON, IXOFF */
  69 #ifndef _POSIX_SOURCE
  70 #define VLNEXT          14      /* IEXTEN */
  71 #define VDISCARD        15      /* IEXTEN */
  72 #endif
  73 #define VMIN            16      /* !ICANON */
  74 #define VTIME           17      /* !ICANON */
  75 #ifndef _POSIX_SOURCE
  76 #define VSTATUS         18      /* ICANON together with IEXTEN */
  77 /*                      19         spare 2 */
  78 #endif
  79 #define NCCS            20
  80
  81 #define _POSIX_VDISABLE 0xff
  82
  83 #ifndef _POSIX_SOURCE
  84 #define CCEQ(val, c)    ((c) == (val) ? (val) != _POSIX_VDISABLE : 0)
  85 #endif
  86
  87 /*
  88  * Input flags - software input processing
  89  */
  90 #define IGNBRK          0x00000001      /* ignore BREAK condition */
  91 #define BRKINT          0x00000002      /* map BREAK to SIGINTR */
  92 #define IGNPAR          0x00000004      /* ignore (discard) parity errors */
  93 #define PARMRK          0x00000008      /* mark parity and framing errors */
  94 #define INPCK           0x00000010      /* enable checking of parity errors */
  95 #define ISTRIP          0x00000020      /* strip 8th bit off chars */
  96 #define INLCR           0x00000040      /* map NL into CR */
  97 #define IGNCR           0x00000080      /* ignore CR */
  98 #define ICRNL           0x00000100      /* map CR to NL (ala CRMOD) */
  99 #define IXON            0x00000200      /* enable output flow control */
 100 #define IXOFF           0x00000400      /* enable input flow control */
 101 #ifndef _POSIX_SOURCE
 102 #define IXANY           0x00000800      /* any char will restart after stop */
 103 #define IMAXBEL         0x00002000      /* ring bell on input queue full */
 104 #endif  /*_POSIX_SOURCE */
 105
 106 /*
 107  * Output flags - software output processing
 108  */
 109 #define OPOST           0x00000001      /* enable following output processing */
 110 #ifndef _POSIX_SOURCE
 111 #define ONLCR           0x00000002      /* map NL to CR-NL (ala CRMOD) */
 112 #define OXTABS          0x00000004      /* expand tabs to spaces */
 113 #define ONOEOT          0x00000008      /* discard EOT's (^D) on output) */
 114 #endif  /*_POSIX_SOURCE */
 115
 116 /*
 117  * Control flags - hardware control of terminal
 118  */
 119 #ifndef _POSIX_SOURCE
 120 #define CIGNORE         0x00000001      /* ignore control flags */
 121 #endif
 122 #define CSIZE           0x00000300      /* character size mask */
 123 #define     CS5             0x00000000      /* 5 bits (pseudo) */
 124 #define     CS6             0x00000100      /* 6 bits */
 125 #define     CS7             0x00000200      /* 7 bits */
 126 #define     CS8             0x00000300      /* 8 bits */
 127 #define CSTOPB          0x00000400      /* send 2 stop bits */
 128 #define CREAD           0x00000800      /* enable receiver */
 129 #define PARENB          0x00001000      /* parity enable */
 130 #define PARODD          0x00002000      /* odd parity, else even */
 131 #define HUPCL           0x00004000      /* hang up on last close */
 132 #define CLOCAL          0x00008000      /* ignore modem status lines */
 133 #ifndef _POSIX_SOURCE
 134 #define CCTS_OFLOW      0x00010000      /* CTS flow control of output */
 135 #define CRTSCTS         (CCTS_OFLOW | CRTS_IFLOW)
 136 #define CRTS_IFLOW      0x00020000      /* RTS flow control of input */
 137 #define CDTR_IFLOW      0x00040000      /* DTR flow control of input */
 138 #define CDSR_OFLOW      0x00080000      /* DSR flow control of output */
 139 #define CCAR_OFLOW      0x00100000      /* DCD flow control of output */
 140 #define MDMBUF          0x00100000      /* old name for CCAR_OFLOW */
 141 #endif
 142
 143
 144 /*
 145  * "Local" flags - dumping ground for other state
 146  *
 147  * Warning: some flags in this structure begin with
 148  * the letter "I" and look like they belong in the
 149  * input flag.
 150  */
 151
 152 #ifndef _POSIX_SOURCE
 153 #define ECHOKE          0x00000001      /* visual erase for line kill */
 154 #endif  /*_POSIX_SOURCE */
 155 #define ECHOE           0x00000002      /* visually erase chars */
 156 #define ECHOK           0x00000004      /* echo NL after line kill */
 157 #define ECHO            0x00000008      /* enable echoing */
 158 #define ECHONL          0x00000010      /* echo NL even if ECHO is off */
 159 #ifndef _POSIX_SOURCE
 160 #define ECHOPRT         0x00000020      /* visual erase mode for hardcopy */
 161 #define ECHOCTL         0x00000040      /* echo control chars as ^(Char) */
 162 #endif  /*_POSIX_SOURCE */
 163 #define ISIG            0x00000080      /* enable signals INTR, QUIT, [D]SUSP */
 164 #define ICANON          0x00000100      /* canonicalize input lines */
 165 #ifndef _POSIX_SOURCE
 166 #define ALTWERASE       0x00000200      /* use alternate WERASE algorithm */
 167 #endif  /*_POSIX_SOURCE */
 168 #define IEXTEN          0x00000400      /* enable DISCARD and LNEXT */
 169 #define EXTPROC         0x00000800      /* external processing */
 170 #define TOSTOP          0x00400000      /* stop background jobs from output */
 171 #ifndef _POSIX_SOURCE
 172 #define FLUSHO          0x00800000      /* output being flushed (state) */
 173 #define NOKERNINFO      0x02000000      /* no kernel output from VSTATUS */
 174 #define PENDIN          0x20000000      /* XXX retype pending input (state) */
 175 #endif  /*_POSIX_SOURCE */
 176 #define NOFLSH          0x80000000      /* don't flush after interrupt */
 177
 178 typedef unsigned int    tcflag_t;
 179 typedef unsigned char   cc_t;
 180 typedef unsigned int    speed_t;
 181
 182 struct termios {
 183         tcflag_t        c_iflag;        /* input flags */
 184         tcflag_t        c_oflag;        /* output flags */
 185         tcflag_t        c_cflag;        /* control flags */
 186         tcflag_t        c_lflag;        /* local flags */
 187         cc_t            c_cc[NCCS];     /* control chars */
 188         speed_t         c_ispeed;       /* input speed */
 189         speed_t         c_ospeed;       /* output speed */
 190 };
 191
 192 /*
 193  * Commands passed to tcsetattr() for setting the termios structure.
 194  */
 195 #define TCSANOW         0               /* make change immediate */
 196 #define TCSADRAIN       1               /* drain output, then change */
 197 #define TCSAFLUSH       2               /* drain output, flush input */
 198 #ifndef _POSIX_SOURCE
 199 #define TCSASOFT        0x10            /* flag - don't alter h.w. state */
 200 #endif
 201
 202 /*
 203  * Standard speeds
 204  */
 205 #define B0      0
 206 #define B50     50
 207 #define B75     75
 208 #define B110    110
 209 #define B134    134
 210 #define B150    150
 211 #define B200    200
 212 #define B300    300
 213 #define B600    600
 214 #define B1200   1200
 215 #define B1800   1800
 216 #define B2400   2400
 217 #define B4800   4800
 218 #define B9600   9600
 219 #define B19200  19200
 220 #define B38400  38400
 221 #ifndef _POSIX_SOURCE
 222 #define B7200   7200
 223 #define B14400  14400
 224 #define B28800  28800
 225 #define B57600  57600
 226 #define B76800  76800
 227 #define B115200 115200
 228 #define B230400 230400
 229 #define EXTA    19200
 230 #define EXTB    38400
 231 #endif  /* !_POSIX_SOURCE */
 232
 233 #ifndef _KERNEL
 234
 235 #define TCIFLUSH        1
 236 #define TCOFLUSH        2
 237 #define TCIOFLUSH       3
 238 #define TCOOFF          1
 239 #define TCOON           2
 240 #define TCIOFF          3
 241 #define TCION           4
 242
 243 #include <sys/cdefs.h>
 244
 245 __BEGIN_DECLS
 246 speed_t cfgetispeed __P((const struct termios *));
 247 speed_t cfgetospeed __P((const struct termios *));
 248 int     cfsetispeed __P((struct termios *, speed_t));
 249 int     cfsetospeed __P((struct termios *, speed_t));
 250 int     tcgetattr __P((int, struct termios *));
 251 int     tcsetattr __P((int, int, const struct termios *));
 252 int     tcdrain __P((int));
 253 int     tcflow __P((int, int));
 254 int     tcflush __P((int, int));
 255 int     tcsendbreak __P((int, int));
 256
 257 #ifndef _POSIX_SOURCE
 258 void    cfmakeraw __P((struct termios *));
 259 int     cfsetspeed __P((struct termios *, speed_t));
 260 #endif /* !_POSIX_SOURCE */
 261 __END_DECLS
 262
 263 #endif /* !_KERNEL */
 264
 265 #ifndef _POSIX_SOURCE
 266
 267 /*
 268  * Include tty ioctl's that aren't just for backwards compatibility
 269  * with the old tty driver.  These ioctl definitions were previously
 270  * in <sys/ioctl.h>.
 271  */
 272 #include <sys/ttycom.h>
 273 #endif
 274
 275 /*
 276  * END OF PROTECTED INCLUDE.
 277  */
 278 #endif /* !_SYS_TERMIOS_H_ */
 279
 280 #ifndef _POSIX_SOURCE
 281 #include <sys/ttydefaults.h>
 282 #endif