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: src/sys/sys/termios.h,v 1.13.2.1 2001/03/06 06:31:44 jhb Exp $
  35  * $DragonFly: src/sys/sys/termios.h,v 1.5 2007/01/08 19:29:23 dillon Exp $
  36  */
  37
  38 #ifndef _SYS_TERMIOS_H_
  39 #define _SYS_TERMIOS_H_
  40
  41 /* Needed by tcgetsid(3). */
  42 #include <sys/stdint.h>
  43 #ifndef _PID_T_DECLARED
  44 typedef __pid_t pid_t;
  45 #define _PID_T_DECLARED
  46 #endif
  47
  48 /*
  49  * Special Control Characters
  50  *
  51  * Index into c_cc[] character array.
  52  *
  53  *      Name         Subscript  Enabled by
  54  */
  55 #define VEOF            0       /* ICANON */
  56 #define VEOL            1       /* ICANON */
  57 #ifndef _POSIX_SOURCE
  58 #define VEOL2           2       /* ICANON together with IEXTEN */
  59 #endif
  60 #define VERASE          3       /* ICANON */
  61 #ifndef _POSIX_SOURCE
  62 #define VWERASE         4       /* ICANON together with IEXTEN */
  63 #endif
  64 #define VKILL           5       /* ICANON */
  65 #ifndef _POSIX_SOURCE
  66 #define VREPRINT        6       /* ICANON together with IEXTEN */
  67 #define VERASE2         7       /* ICANON */
  68 #endif
  69 #define VINTR           8       /* ISIG */
  70 #define VQUIT           9       /* ISIG */
  71 #define VSUSP           10      /* ISIG */
  72 #ifndef _POSIX_SOURCE
  73 #define VDSUSP          11      /* ISIG together with IEXTEN */
  74 #endif
  75 #define VSTART          12      /* IXON, IXOFF */
  76 #define VSTOP           13      /* IXON, IXOFF */
  77 #ifndef _POSIX_SOURCE
  78 #define VLNEXT          14      /* IEXTEN */
  79 #define VDISCARD        15      /* IEXTEN */
  80 #endif
  81 #define VMIN            16      /* !ICANON */
  82 #define VTIME           17      /* !ICANON */
  83 #ifndef _POSIX_SOURCE
  84 #define VSTATUS         18      /* ICANON together with IEXTEN */
  85 #define VCHECKPT        19      /* ICANON together with IEXTEN */
  86 #endif
  87 #define NCCS            20
  88
  89 #define _POSIX_VDISABLE 0xff
  90
  91 #ifndef _POSIX_SOURCE
  92 #define CCEQ(val, c)    ((c) == (val) ? (val) != _POSIX_VDISABLE : 0)
  93 #endif
  94
  95 /*
  96  * Input flags - software input processing
  97  */
  98 #define IGNBRK          0x00000001      /* ignore BREAK condition */
  99 #define BRKINT          0x00000002      /* map BREAK to SIGINTR */
 100 #define IGNPAR          0x00000004      /* ignore (discard) parity errors */
 101 #define PARMRK          0x00000008      /* mark parity and framing errors */
 102 #define INPCK           0x00000010      /* enable checking of parity errors */
 103 #define ISTRIP          0x00000020      /* strip 8th bit off chars */
 104 #define INLCR           0x00000040      /* map NL into CR */
 105 #define IGNCR           0x00000080      /* ignore CR */
 106 #define ICRNL           0x00000100      /* map CR to NL (ala CRMOD) */
 107 #define IXON            0x00000200      /* enable output flow control */
 108 #define IXOFF           0x00000400      /* enable input flow control */
 109 #ifndef _POSIX_SOURCE
 110 #define IXANY           0x00000800      /* any char will restart after stop */
 111 #define IMAXBEL         0x00002000      /* ring bell on input queue full */
 112 #endif  /*_POSIX_SOURCE */
 113
 114 /*
 115  * Output flags - software output processing
 116  */
 117 #define OPOST           0x00000001      /* enable following output processing */
 118 #ifndef _POSIX_SOURCE
 119 #define ONLCR           0x00000002      /* map NL to CR-NL (ala CRMOD) */
 120 #define OXTABS          0x00000004      /* expand tabs to spaces */
 121 #define ONOEOT          0x00000008      /* discard EOT's (^D) on output) */
 122 #define OCRNL           0x00000010      /* map CR to NL on output */
 123 #define ONOCR           0x00000020      /* no CR output at column 0 */
 124 #define ONLRET          0x00000040      /* NL performs CR function */
 125 #endif  /*_POSIX_SOURCE */
 126
 127 /*
 128  * Control flags - hardware control of terminal
 129  */
 130 #ifndef _POSIX_SOURCE
 131 #define CIGNORE         0x00000001      /* ignore control flags */
 132 #endif
 133 #define CSIZE           0x00000300      /* character size mask */
 134 #define     CS5             0x00000000      /* 5 bits (pseudo) */
 135 #define     CS6             0x00000100      /* 6 bits */
 136 #define     CS7             0x00000200      /* 7 bits */
 137 #define     CS8             0x00000300      /* 8 bits */
 138 #define CSTOPB          0x00000400      /* send 2 stop bits */
 139 #define CREAD           0x00000800      /* enable receiver */
 140 #define PARENB          0x00001000      /* parity enable */
 141 #define PARODD          0x00002000      /* odd parity, else even */
 142 #define HUPCL           0x00004000      /* hang up on last close */
 143 #define CLOCAL          0x00008000      /* ignore modem status lines */
 144 #ifndef _POSIX_SOURCE
 145 #define CCTS_OFLOW      0x00010000      /* CTS flow control of output */
 146 #define CRTSCTS         (CCTS_OFLOW | CRTS_IFLOW)
 147 #define CRTS_IFLOW      0x00020000      /* RTS flow control of input */
 148 #define CDTR_IFLOW      0x00040000      /* DTR flow control of input */
 149 #define CDSR_OFLOW      0x00080000      /* DSR flow control of output */
 150 #define CCAR_OFLOW      0x00100000      /* DCD flow control of output */
 151 #define MDMBUF          0x00100000      /* old name for CCAR_OFLOW */
 152 #endif
 153
 154
 155 /*
 156  * "Local" flags - dumping ground for other state
 157  *
 158  * Warning: some flags in this structure begin with
 159  * the letter "I" and look like they belong in the
 160  * input flag.
 161  */
 162
 163 #ifndef _POSIX_SOURCE
 164 #define ECHOKE          0x00000001      /* visual erase for line kill */
 165 #endif  /*_POSIX_SOURCE */
 166 #define ECHOE           0x00000002      /* visually erase chars */
 167 #define ECHOK           0x00000004      /* echo NL after line kill */
 168 #define ECHO            0x00000008      /* enable echoing */
 169 #define ECHONL          0x00000010      /* echo NL even if ECHO is off */
 170 #ifndef _POSIX_SOURCE
 171 #define ECHOPRT         0x00000020      /* visual erase mode for hardcopy */
 172 #define ECHOCTL         0x00000040      /* echo control chars as ^(Char) */
 173 #endif  /*_POSIX_SOURCE */
 174 #define ISIG            0x00000080      /* enable signals INTR, QUIT, [D]SUSP */
 175 #define ICANON          0x00000100      /* canonicalize input lines */
 176 #ifndef _POSIX_SOURCE
 177 #define ALTWERASE       0x00000200      /* use alternate WERASE algorithm */
 178 #endif  /*_POSIX_SOURCE */
 179 #define IEXTEN          0x00000400      /* enable DISCARD and LNEXT */
 180 #define EXTPROC         0x00000800      /* external processing */
 181 #define TOSTOP          0x00400000      /* stop background jobs from output */
 182 #ifndef _POSIX_SOURCE
 183 #define FLUSHO          0x00800000      /* output being flushed (state) */
 184 #define NOKERNINFO      0x02000000      /* no kernel output from VSTATUS */
 185 #define PENDIN          0x20000000      /* XXX retype pending input (state) */
 186 #endif  /*_POSIX_SOURCE */
 187 #define NOFLSH          0x80000000      /* don't flush after interrupt */
 188
 189 typedef unsigned int    tcflag_t;
 190 typedef unsigned char   cc_t;
 191 typedef unsigned int    speed_t;
 192
 193 struct termios {
 194         tcflag_t        c_iflag;        /* input flags */
 195         tcflag_t        c_oflag;        /* output flags */
 196         tcflag_t        c_cflag;        /* control flags */
 197         tcflag_t        c_lflag;        /* local flags */
 198         cc_t            c_cc[NCCS];     /* control chars */
 199         speed_t         c_ispeed;       /* input speed */
 200         speed_t         c_ospeed;       /* output speed */
 201 };
 202
 203 /*
 204  * Commands passed to tcsetattr() for setting the termios structure.
 205  */
 206 #define TCSANOW         0               /* make change immediate */
 207 #define TCSADRAIN       1               /* drain output, then change */
 208 #define TCSAFLUSH       2               /* drain output, flush input */
 209 #ifndef _POSIX_SOURCE
 210 #define TCSASOFT        0x10            /* flag - don't alter h.w. state */
 211 #endif
 212
 213 /*
 214  * Standard speeds
 215  */
 216 #define B0      0
 217 #define B50     50
 218 #define B75     75
 219 #define B110    110
 220 #define B134    134
 221 #define B150    150
 222 #define B200    200
 223 #define B300    300
 224 #define B600    600
 225 #define B1200   1200
 226 #define B1800   1800
 227 #define B2400   2400
 228 #define B4800   4800
 229 #define B9600   9600
 230 #define B19200  19200
 231 #define B38400  38400
 232 #ifndef _POSIX_SOURCE
 233 #define B7200   7200
 234 #define B14400  14400
 235 #define B28800  28800
 236 #define B57600  57600
 237 #define B76800  76800
 238 #define B115200 115200
 239 #define B230400 230400
 240 #define EXTA    19200
 241 #define EXTB    38400
 242 #endif  /* !_POSIX_SOURCE */
 243
 244 #define TCIFLUSH        1
 245 #define TCOFLUSH        2
 246 #define TCIOFLUSH       3
 247 #define TCOOFF          1
 248 #define TCOON           2
 249 #define TCIOFF          3
 250 #define TCION           4
 251
 252 #include <sys/cdefs.h>
 253
 254 __BEGIN_DECLS
 255 speed_t cfgetispeed (const struct termios *);
 256 speed_t cfgetospeed (const struct termios *);
 257 int     cfsetispeed (struct termios *, speed_t);
 258 int     cfsetospeed (struct termios *, speed_t);
 259 int     tcgetattr (int, struct termios *);
 260 int     tcsetattr (int, int, const struct termios *);
 261 int     tcdrain (int);
 262 int     tcflow (int, int);
 263 int     tcflush (int, int);
 264 int     tcsendbreak (int, int);
 265
 266 #if     __XSI_VISIBLE
 267 pid_t   tcgetsid(int);
 268 #endif  /* !_XSI_VISIBLE */
 269
 270 #ifndef _POSIX_SOURCE
 271 void    cfmakeraw (struct termios *);
 272 int     cfsetspeed (struct termios *, speed_t);
 273 #endif /* !_POSIX_SOURCE */
 274 __END_DECLS
 275
 276 #ifndef _POSIX_SOURCE
 277
 278 /*
 279  * Include tty ioctl's that aren't just for backwards compatibility
 280  * with the old tty driver.  These ioctl definitions were previously
 281  * in <sys/ioctl.h>.
 282  */
 283 #include <sys/ttycom.h>
 284 #endif
 285
 286 /*
 287  * END OF PROTECTED INCLUDE.
 288  */
 289 #endif /* !_SYS_TERMIOS_H_ */
 290
 291 #ifndef _POSIX_SOURCE
 292 #include <sys/ttydefaults.h>
 293 #endif