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